Skip to content

docs: CIワークフローの実行ポリシーをドキュメント化#1297

Open
Hiroshiba wants to merge 1 commit intomainfrom
docs/add-ci-workflow-policy
Open

docs: CIワークフローの実行ポリシーをドキュメント化#1297
Hiroshiba wants to merge 1 commit intomainfrom
docs/add-ci-workflow-policy

Conversation

@Hiroshiba
Copy link
Member

@Hiroshiba Hiroshiba commented Feb 11, 2026

内容

docs/guide/dev/ci.mdを新規作成し、CIの書き方ポリシーをドキュメント化してみました。

PRではon.pull_request.pathsによりワークフローを選択実行してCI時間を短縮しているが、pathsフィルタはコード変更に伴い実態と乖離しうる。
そのためmainブランチへのpushでは全ワークフローを網羅的に実行することでカバーしているという設計判断を記載。

関連 Issue

なし

検討した他の案

8つのワークフローファイルのpaths:付近に同じコメントを追加する案。
8ファイルに同じコメントを書くのは冗長なのでやめました。

既存の「プルリクエストにおけるCI」セクションに追記する案。
この情報はワークフローを編集する際に把握しておくべきポリシーであり、コントリビューター向けというよりメンテナ向けなのでdocs/guide/dev/に書いてみました。

その他

なし

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Copy link
Member Author

@Hiroshiba Hiroshiba Feb 11, 2026

Choose a reason for hiding this comment

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

わざわざファイルを追加するほどだろうかとも思ったのですが、他に良さそうなファイルがなかったので作ってみました 🙇

まあCI関連の項目足しやすいし、もし他のファイルができて統合できるってなったら統合すれば良いのかな、くらいの気持ちです 🙇

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

CIワークフローの実行ポリシー(PRでは on.pull_request.paths で実行対象を絞り、main への push では網羅的に実行して乖離リスクをカバーする設計判断)を開発者向けドキュメントとして明文化するPRです。

Changes:

  • docs/guide/dev/ci.md を新規作成し、CIの実行ポリシーを簡潔に記載

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# CI

プルリクエストでは`on.pull_request.paths`により関連するワークフローのみを実行し、CI時間を短縮する。
pathsフィルタはコード変更に伴い実態と乖離しうるため、mainブランチへのpushでは全ワークフローを網羅的に実行することでカバーする。
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

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

「mainブランチへのpushでは全ワークフローを網羅的に実行」とありますが、少なくとも audit.ymlpush をトリガーにしておらず(schedule/workflow_dispatchのみ)、download_test.yml も push/pull_request がコメントアウトされています。実態としては「pathsフィルタを付けているワークフローは main への push では paths 制限なしで実行する」など、対象を限定した表現にすると正確になります。

Suggested change
pathsフィルタはコード変更に伴い実態と乖離しうるため、mainブランチへのpushでは全ワークフローを網羅的に実行することでカバーする
pathsフィルタはコード変更に伴い実態と乖離しうるため、pathsフィルタを付けているワークフローについては main ブランチへの push 時には paths 制限なしで実行することでカバーする

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant