Document the release lines and the divergent version value - #2126
Open
Tyrie Vella (tyrielv) wants to merge 1 commit into
Open
Tyrie Vella (tyrielv) wants to merge 1 commit into
Tyrie Vella (tyrielv) wants to merge 1 commit into
Conversation
Tyrie Vella (tyrielv)
force-pushed
the
tyrielv/anchor-version-comment
branch
from
September 30, 2026 21:09
9ca9279 to
92be616
Compare
The GVFSMajorAndMinorVersion value in release.yml differs between vnext and master. Nothing in the file says this is deliberate, and nothing in the repository describes the two release lines. A future merge conflict on this line could take the other branch's value and undo a version bump without notice. No CI job parses release.yml, so nothing downstream would catch it. Add a comment above the value that records the intent. The comment names the two branches that diverge, but it states no version numbers, so it stays correct after vnext is promoted. Add a "Release lines and version numbers" section to AGENTS.md. The section describes what master and vnext build, how the pipeline forms the full version and tag, and why a cross-line merge always uses a merge commit. Assisted-by: Claude Opus 5 Signed-off-by: Tyrie Vella <tyrielv@gmail.com>
Tyrie Vella (tyrielv)
force-pushed
the
tyrielv/anchor-version-comment
branch
from
September 30, 2026 21:14
92be616 to
349d264
Compare
Tyrie Vella (tyrielv)
enabled auto-merge
September 30, 2026 21:34
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.
Problem and Context
After #2123,
GVFSMajorAndMinorVersionin.azure-pipelines/release.ymldiffers betweenmasterandvnext. This PR follows up review feedback on #2123.Two gaps make that difference fragile.
First, nothing in the file says the difference is deliberate.
masteris merged intovnextoften. Today the merge is clean, becausemasterdoes not change this line. The first timemasterchanges it, both sides will have changed it and Git will report a conflict. A person who resolves that conflict can take themastervalue and silently undo the version bump. No CI job parses.azure-pipelines/release.yml, so nothing downstream would catch the mistake.Second, the repository does not describe its release lines anywhere. A contributor cannot find out what
masterandvnextbuild, or why the two branches carry different version values.Changes
GVFSMajorAndMinorVersionin.azure-pipelines/release.yml. The comment says the value is intentionally different betweenvnextandmaster, and tells the reader to confirm which line the branch ships before resolving a conflict. The comment names the two branches but states no version numbers, because version numbers would become wrong whenvnextis promoted tomaster.AGENTS.md, next to the existing release and version material. The section records whatmasterandvnextbuild, how the release pipeline forms the full version and the tag fromGVFSMajorAndMinorVersionplus the build number, how the two lines are kept in sync, and why a cross-line merge always uses a merge commit.