Update release-checklist.md#13754
Merged
Merged
Conversation
Phase 1.3 of the release checklist previously only described inserting the new release branch into .config/git-merge-flow-config.jsonc. It said nothing about removing retired predecessor VS preview branches, so each release relied on someone noticing the stale entries (e.g. PR dotnet#13750 had to retire vs18.4 and vs18.5 manually after vs18.6 opened). Expand step 1.3 into 1.3a (insert new branch), 1.3b (retire unsupported predecessor preview branches), and 1.3c (sanity-check the resulting chain) so the cleanup happens as part of the same PR that adds the new branch. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the release checklist to make merge-flow branch retirement an explicit part of adding a new release branch, helping keep automated forward-merge PRs aligned with supported VS branches.
Changes:
- Splits release checklist step 1.3 into explicit substeps.
- Adds guidance to retire unsupported predecessor preview branches from
.config/git-merge-flow-config.jsonc. - Adds a sanity-check step for validating the resulting merge chain.
Remove the made-up criterion describing exactly when a branch is retired (content merged forward + past LTSC/STS / no future patches). That heuristic was not based on any documented policy and risks being wrong. Leave 1.3b as a prompt to retire predecessor branches that will no longer be supported, with the example PR for context. Reasoning for how to identify a retired branch will be added separately. Also drop 1.3c (chain well-formedness check) — the new sub-step doesn't need that scaffolding. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Documentation review — no issues found.
The decomposition of step 1.3 into sub-steps (1.3a–1.3c) is well-structured and consistent with the existing pattern used for step 1.2 (1.2a–1.2e). The new branch-retirement guidance in 1.3b is detailed, actionable, and correctly describes the mechanics of the merge-flow config. The verification step in 1.3c adds a useful safety gate. The cross-reference to PR #13750 as a concrete example is helpful for future release operators.
Formatting and markdown nesting are correct.
Note
🔒 Integrity filter blocked 1 item
The following item were blocked because they don't meet the GitHub integrity level.
- #13754
pull_request_read: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
To allow these resources, lower min-integrity in your GitHub frontmatter:
tools:
github:
min-integrity: approved # merged | approved | unapproved | noneGenerated by Expert Code Review (on open) for issue #13754 · ● 1.5M
For SDK releases, refer to the lifecycle table in the SDK/MSBuild/VS versioning doc. For VS releases, the retired branch is always the immediate predecessor of the one being released. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The release checklist already covers BootstrapSdkVersion (the SDK that hosts bootstrap test runs) but not the tools.dotnet pin in global.json (the SDK that builds MSBuild itself, surfaced as DotNetCliVersion in eng/Versions.props and required to match per the comment there). Add 5.4b so the build-side SDK is refreshed on the same monthly cadence as new SDK releases. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Inputs: fix BRANCH_SNAP_DATE description; add PACKAGE_VALIDATION_BASELINE_VERSION row and 'how to determine' reference section from dotnet#13676. - Phase 0: fix invalid 'darc get-channel --name' to 'darc get-channels' + filter; remove inline artifact tracking table. - Phase 1: add 1.0 pre-snap team check; add admin-rights note to 1.1; drop unusable --configuration-branch release/msbuild-... from all darc commands in 1.2; delete 1.2e (First Responders ping); rewrite 1.3b retirement rule as combined SDK + VS lifecycle (only retire when both agree; link VS Servicing wiki). - Phase 2 (was Phase 3) - DARC subscription updates: swapped before bump-main so VMR consumes correct channel; dropped --configuration-branch from all commands; new 2.3e to delete subscriptions for retired branches mirroring 1.3b combined rule; cross-refs updated; Roslyn/NuGet verification removed (steady-state, out-of-band); URL_OF_PHASE3_DARC_PR renamed to URL_OF_PHASE2_DARC_PR. - Phase 3 (was Phase 2) - bump main: 3.2 references PACKAGE_VALIDATION_BASELINE_VERSION; 3.3 marked as fix-up only on pipeline API-compat failure; deleted obsolete AutoInsertTargetBranch retarget step. - Phase 4: 4.4 OptProf rewritten to 2 steps (cancel auto-triggered build; re-run manually with main override); 4.7/4.8 servicing-only callout retained. - Phase 5: 5.5a cross-ref to Phase 2 (post-swap). - New 'Release Output' table at bottom of file replacing the Phase 0 inline tracking table. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JanProvaznik
requested changes
May 28, 2026
JanProvaznik
left a comment
Member
There was a problem hiding this comment.
very good improvement of clarity, few points to make even better
Replaces the blanket 'Roslyn and NuGet verification omitted' note with a NuGet-specific reminder. NuGet's dev branch publishes to a band-specific channel (today .NET 10.0.4xx SDK), so when the next-to-ship SDK band rotates our main subscription will silently start pulling the previous band's servicing builds instead of latest dev unless we re-point its channel.
This was referenced Jun 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates
documentation/release-checklist.mdso it will covers the actual process of the release.Inputs section
{{PACKAGE_VALIDATION_BASELINE_VERSION}}as a real input + new "How to determine" subsection. Previous version description was incorrect.{{BRANCH_SNAP_DATE}}description: was "from VS-Dates wiki", corrected to "date we createvs{{THIS_RELEASE_VERSION}}frommain". Source: user-confirmed; the date is not on the wiki.Phase 0
darc get-channel --name "VS X.Y"→darc get-channels(then grep). Source: user-confirmed--nameis not a valid flag forget-channel.Phase 1
1.0pre-snap team check (ping team for anything that must still merge intomainbefore snap).1.1admin-rights note —git pushtorefs/heads/vs*is restricted.--configuration-branch release/msbuild-...→--configuration-branch msbuild-...(droppedrelease/prefix) on all darc write commands. Reason: pushes torelease/-prefixed branches in the maestro-configuration repo are restricted.1.2e(Ping "First Responders" Teams channel for channel promotion). Reason: step is no longer needed.1.3into1.3a+1.3b—1.3akeeps the original "insert new branch",1.3bis new: retire predecessor branches. Combined SDK + VS retirement rule.Phase 2 ↔ Phase 3 swap
mainbumps, otherwise the first post-bumpmainbuild lands on the now-staleVS {{THIS_RELEASE_VERSION}}channel.Phase 2 (new — DARC Subscription Updates)
2.4) — was "rarely changes", now requires every supported branch to have an Arcade subscription from the matching.NET <X> Engchannel. Source: meeting — the vs18.6 release was blocked by a missing Arcade subscription; the old "rarely changes" wording actively discouraged the check it claimed to mandate.3.5(NuGet verify) +3.6(Roslyn verify) +3.7(confirm disabled) +3.8(fix-up step). Replaced with a single blockquote that:main; channel does not rotate with SDK bands), and4xx→5xx), the NuGet →msbuild/mainsubscription must be re-pointed to the new band's channel.2.3e— delete subscriptions for retired branches (using the same combined SDK+VS rule from 1.3b). Source: user-confirmed cleanup is symmetric with 1.3b.Phase 3 (new — Bump Main & Update Pipelines)
3.2now references{{PACKAGE_VALIDATION_BASELINE_VERSION}}instead of "last released version (the{{PREVIOUS_RELEASE_VERSION}}GA version)". Reason: — GA version is wrong; baseline must be a preview build whose source commit is invs{{THIS_RELEASE_VERSION}}history.3.3(CompatibilitySuppressions.xml) reframed as "only if the pipeline fails on API-compat — this step is a fix-up, not a routine action".2.4(AutoInsertTargetBranch → VS main). Reason: step is no longer needed._3.4(vs-insertion-experimental.ymlTargetBranchadd). Reason: this is no longer needed manually._Phase 4
4.4OptProf bootstrap into two clean steps:4.4acancel the auto-triggered failing build,4.4bre-run manually withmain's OptProf override. Reason: — the original 3-step variant did not reflect what we actually do; auto-triggered build is doomed and must be cancelled first.4.5(M2/QB approval) — added "only required if we are behind the VS schedule" note. Reason: — on-time releases skip this step entirely._4.7/4.8explaining these are NOT part of the regular release flow; they only apply when servicing a previously-shipped release with a hotfix commit.Phase 5
5.1(Push to nuget.org) - now reflects actual process.5.2(Publish docs) - now reflects actual process.5.3(GitHub release) expanded to5.3a–5.3d:5.3aprecondition: confirm previous release tag exists onupstream; if missing, create it first.5.3bidentify the commit to tag = the source commit of the build identified in5.1b5.4b— bumptools.dotnetinglobal.jsonto latest released SDK in the targeted band.5.5(Extend OptProf data expiration for LTSC). Reason: now we have 3-year default retention for opt prof artefacts).5.6(re-verify main subscription) — deleted as a redundant Phase-2 echo.5.5— verify the overall subscription map across every still-supported branch (not just the one being released).