Skip to content

Commit efeafcb

Browse files
committed
docs: update release-doc-sync header comment to reflect actual @v1 / @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
1 parent a402b8c commit efeafcb

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

.github/actions/release-doc-sync/action.yml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,19 @@
2727
# list as outputs so the caller can branch on them or include them in
2828
# the release commit message.
2929
#
30-
# Pinning rule: tool repos MUST consume this action via @v1.0 (or a SHA),
31-
# never @main. The meta-repo's tag pipeline maintains the v1.0 tag pointing
32-
# at the latest 1.x.y. See DTD#14 for the floating-tag automation
33-
# follow-up. The drift-check@v1.7 lessons apply: @main from a tool repo
34-
# means every meta-repo PR can break every tool-repo release.
30+
# Pinning rule: tool repos MUST consume this action via a floating tag or a
31+
# SHA, never @main. Three supported pin styles:
32+
# - @v1 (floating major, default; auto-maintained by release.yml on
33+
# every release; what most consumers use)
34+
# - @v1.X (floating minor, e.g. @v1.9; auto-maintained; used by strict
35+
# consumers that want minor-level pinning while still picking up
36+
# patch updates automatically)
37+
# - @<SHA> (full commit SHA; strictest, manual maintenance; used only when
38+
# a consumer needs to freeze the action at a specific point)
39+
# The meta-repo's tag pipeline maintains @v1 and the @v1.X floating tags on
40+
# every release. See DTD#14 for the floating-tag automation status. The
41+
# drift-check@v1.7 lessons apply: @main from a tool repo means every
42+
# meta-repo PR can break every tool-repo release.
3543
# =============================================================================
3644

3745
name: 'Release doc sync'

0 commit comments

Comments
 (0)