Skip to content

docs: simplify RELEASE.md and correct release process#532

Open
singhk97 wants to merge 5 commits into
mainfrom
docs/update-release-process
Open

docs: simplify RELEASE.md and correct release process#532
singhk97 wants to merge 5 commits into
mainfrom
docs/update-release-process

Conversation

@singhk97
Copy link
Copy Markdown
Collaborator

Summary

  • Rewrites RELEASE.md to be cleaner and more scannable, modeled after the TS SDK release doc
  • Corrects the Core release flow to use a prep-release branch with PR (same as Legacy), with Microsoft.Teams.Apps keeping its preview suffix
  • Updates Core version examples to reflect current 1.0.2 → next 1.0.3
  • Adds new sections: Hotfixes, Experimental Features, Bumping Major/Minor Version, How Versioning Works
  • Removes verbose pipeline tables, CI validation details, and publicReleaseRefSpec notes

Test plan

  • Review rendered markdown for formatting
  • Confirm Core and Legacy release steps match current team process

🤖 Generated with Claude Code

Rewrite RELEASE.md to match the cleaner style of the TS SDK release doc.
Core and Legacy now both use a prep-release branch flow with PR-based
merges. Core keeps the Microsoft.Teams.Apps preview suffix unchanged.
Adds sections for hotfixes, experimental features, and version bumping.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 28, 2026 15:53
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR rewrites the repository release guide to make the .NET SDK release process more concise and easier to follow.

Changes:

  • Replaces the older pipeline-heavy release documentation with step-by-step Core and Legacy release flows.
  • Adds guidance for hotfixes, experimental versions, major/minor bumps, publishing, and approvers.
  • Updates release instructions around prep-release branches and public publishing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md
2. Select **teams-net-publish**
3. Click **Approvals and checks**
4. Add/remove approvers as needed
1. Edit `version.json` on `main`
Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
singhk97 and others added 3 commits May 28, 2026 13:39
Use git merge -s ours strategy to avoid conflicts when merging
prep-release branches into release branches.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documents the post-publish step for creating the GitHub Release and tag,
including the fallback PR-delta query for when auto-generated notes are
sparse due to squash-merge ancestry.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 29, 2026 16:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

Comment thread RELEASE.md
Comment on lines +17 to +20
2. Update `version.json` to set the stable version (remove the `-preview.{height}` suffix):
- **Core**: edit `core/version.json` (e.g., set `"version": "1.0.3"`)
- Do **not** modify `core/src/Microsoft.Teams.Apps/version.json` — keep its preview suffix as-is for now
- **Legacy**: edit root `version.json` (e.g., set `"version": "2.0.8"`)
Comment thread RELEASE.md
- **Legacy** (`Libraries/`): root `version.json` (e.g., `2.0.7-preview.{height}`)
- **Core** (`core/`): `core/version.json` (e.g., `1.0`)
7. Bump the version on `main` for the next release cycle:
- **Core**: edit `core/version.json` (e.g., `"1.0.3-preview.{height}"` → `"1.0.4-preview.{height}"`)
Comment thread RELEASE.md
Comment on lines +138 to +141
- `Libraries/**`, `Samples/**`, `Tests/**`, `Microsoft.Teams.sln`, `version.json` → Legacy
- `core/**` → Core
- `.editorconfig`, `.azdo/**`, `Makefile` → both (shared infrastructure)
- `**/*.md`, `docs/**`, `Assets/**` → neither (skipped)
Comment thread RELEASE.md
Comment on lines +99 to +101
- **Main branch**: `X.Y.Z-preview.1`, `X.Y.Z-preview.2`, etc. (prerelease)
- **Release branch**: `X.Y.Z` (stable, published to nuget.org)
- **Feature branch**: versions include the commit hash (e.g., `2.0.7-preview.42-g1a2b3c4`)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants