docs: update release-doc-sync header comment to reflect actual @v1 / @v1.X convention#52
Merged
TMHSDigital merged 1 commit intomainfrom Apr 26, 2026
Conversation
…@v1.X convention Closes DTD#44. The previous comment referenced @v1.0 (a tag that was never created; DTD#42 fixed the runtime default but not the comment). New text describes the three supported pin styles (@v1, @v1.X, @<SHA>) accurately. Made-with: Cursor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
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 release-doc-sync action header comment to reflect the actual current pin convention.
Previous text
Referenced
@v1.0as the canonical pin and described the meta-repo as maintaining "the v1.0 tag pointing at the latest 1.x.y". Thev1.0tag was never actually created. DTD#42 fixed the runtime default of themeta-repo-refinput (changed fromv1.0tov1) but the header comment was deliberately left untouched in that change to keep the diff scoped.New text
Describes the three supported pin styles:
@v1- floating major, default; auto-maintained byrelease.ymlon every release; what most consumers use@v1.X- floating minor (e.g.@v1.9); auto-maintained; for consumers that want minor-level pinning while still picking up patch updates@<SHA>- full commit SHA; strictest, manual maintenance; for consumers that need to freeze the action at a specific pointScope
Single header comment edit, no runtime behavior change.
docs:prefix means no VERSION bump and no auto-release fires (correct for a doc-only fix; the runtime default and tags are unchanged).Closes #44.