Skip to content

docs: github-flow-guardrails の reusable workflow の参照形式の記述を現状に合わせる - #575

Merged
kmryst merged 1 commit into
mainfrom
574-docs-reusable-workflow-ref-forms
Oct 13, 2026
Merged

kmryst merged 1 commit into
mainfrom
574-docs-reusable-workflow-ref-forms

Conversation

@kmryst

@kmryst kmryst commented Oct 13, 2026 •

Copy link
Copy Markdown
Owner

目的(推奨)

docs/operations/github-flow-guardrails.md の「現時点の技術的な未収束点」が、idp-golden-path の reusable workflow を @v1 で消費すると書いており、現状(@v1 5 本 / patch 版のタグ固定 7 本)と食い違っていたため、版数に依存しない書き方で現状に合わせる。

変更内容(推奨)

影響範囲(推奨)

  • 対象: docs/operations/github-flow-guardrails.md のみ
  • 非対象: workflow、ADR(0034 / 0035 / 0036 の版数・@v1 は決定時点の記録)、runbook(pr-policy-check-concurrency.md の 2026-07-13 の移行記録)

PR ラベル(必須)

  • type: type:docs
  • area: area:docs, area:ci-cd
  • risk: risk:low
  • cost: cost:none

可観測性 / 検証 条件付き

No-op(適用外)。docs のみ。

  • 記載内容は .github/workflows/*.yml の uses:(2026-10-13 時点)と、各 caller の初回参照コミット(git log -S)で確認した
  • ローカル: npm run lint:md → exit 0、npx commitlint --from origin/main --to HEAD / PR タイトル → 0 problems

ロールバック 条件付き

この PR を revert する(docs のみ)。

リリース連携(推奨)

  • リリースノート: 不要

メモ(レビューポイント)

  • patch 版のタグ固定を ADR-0008 の原則(@v1)に揃えるかは、この PR では判断していない

Closes #574

🤖 Generated with Claude Code

https://claude.ai/code/session_01PPszW4Rvm6ppEAvUWbRP6j

「現時点の技術的な未収束点」が idp-golden-path の reusable workflow を
`@v1` で消費すると書いていたが、Dependabot の github-actions 更新などで
patch 版のタグ固定の caller が 7 本に増えており、現状と食い違っていた。

- 導入経緯の 3 箇所から ref の記載を外す
- 2 つの ref 形式(移動タグ `@v1` / patch 版のタグ)と caller の対応、
  patch 版の経緯と更新の経路(Dependabot の github-actions 更新、急ぐ場合は手動 PR)を
  時点付きで追記する。版数そのものは書かず、各 caller workflow の `uses:` を正とする

ADR と runbook の時点付きの記述は過去の事実の記録のため変更しない。

Refs #574

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PPszW4Rvm6ppEAvUWbRP6j
@kmryst kmryst added type:docs ドキュメント修正 risk:low 低リスク・影響範囲小・ロールバック容易 cost:none コスト影響なし area:docs ドキュメント関連 area:ci-cd CI/CD 関連 labels Oct 13, 2026

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This documentation update accurately corrects the description of reusable workflow reference formats to match the current implementation state. The changes properly remove outdated @v1 references and add comprehensive documentation of the two ref formats currently in use (@v1 for 5 workflows, @v1.x.y for 7 workflows), along with historical context and update paths.

The documentation is well-structured, clearly explains the current state as of 2026-10-13, and appropriately notes that the decision to align with ADR-0008's @v1 principle has not yet been recorded. No blocking issues identified.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@kmryst
kmryst merged commit b146934 into main Oct 13, 2026
36 checks passed
@kmryst
kmryst deleted the 574-docs-reusable-workflow-ref-forms branch October 13, 2026 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:ci-cd CI/CD 関連 area:docs ドキュメント関連 cost:none コスト影響なし risk:low 低リスク・影響範囲小・ロールバック容易 type:docs ドキュメント修正

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: github-flow-guardrails の reusable workflow の参照形式の記述を現状に合わせる

1 participant