Git のワークフロー
作業は既定ブランチから始め、作業用ブランチの変更をプルリクエスト(PR)で既定ブランチに取 り込む。 GitHubのラベルはラベル運用ルールを参照する。
使用するブランチの役割
- 既定ブランチは、レビュー済みの変更を取り込むブランチである。
このリポジトリでは
masterが該当する - 作業用ブランチは、機能追加や不具合修正、文書の更新に使う
- リリース用ブランチは、本番へデプロイする変更をまとめるブランチである。
このリポジトリではGitHub Actionsの
本番リリースワークフローがmasterをreleaseに取り込む
本番へ配布したコミットの記録は、本番リリースの記録を参照する。
通常の開発のブランチ管理の流れ
- 最新の既定ブランチから作業用ブランチを作る
- 変更を確認し、既定ブランチを取り込み先にしたPRを開く。 作業途中でフィードバックがほしい場合はドラフトPRを使う
- レビューと検証が済んだらPRをマージし、作業用ブランチを削除する
変更を段階的にレビューする場合は、作業用ブランチから子ブランチを作り、そのPRの取り込み先を親ブランチにする。 緊急の修正も既定ブランチに取り込み、本番反映は次の手順に従う。
本番反映
本番の公開は release ブランチへの反映で行う。
Cloudflare Workers Buildsがreleaseへのpushを受けて静的ファイルをデプロイする。
master から release へのプルリクエストは使わない。
releaseはSettings → Rules → Rulesetsのreleaseルールセットで保護する。
「Require a pull request before merging」は付けない。
必須ステータスと削除禁止は残してよい。
個人リポジトリではGITHUB_TOKENはリポジトリ管理者ロールのbypassに当たらない。
手順は次のとおりである。
- 取り込む変更が
masterにマージ済みであることを確認する - GitHubのActionsからワークフロー
本番リリースを開く - 実行ブランチに
masterを選び、Run workflowする - ワークフローが
masterをreleaseにマージする - 履歴を直線のまま取り込めるときはfast-forwardにする。できないときはmerge commitにする
- 同じ実行でタグ
release-YYYY-MM-DD-NとGitHub Releaseを作る - Cloudflareの本番デプロイ完了を確認する
- 版情報の
commitがReleaseのSHAと一致することを確認する
取り込むコ ミットが無い場合、ワークフローは何もしない。
コンフリクトした場合は失敗するため、release 側の差分を解消してから再実行する。
マージ後に記録だけ失敗した場合は、同じワークフロー実行を再実行するか、record_onlyを有効にして実行する。
記録のタグ名、本文、/version.json の契約は 本番リリースの記録 に従う。
このサイトではCloudflare API用のシークレットを増やさない。
そのためBuilds完了待ちとスモークテストはワークフローに含めない。
版情報の確認は手順8で行う。
ブランチ名の付け方
ブランチ名の前半には、作業の種類や使用するエージェントが分かる接頭辞を付ける。 後半には変更内容を表す短い英語を使い、単語をハイフンでつなぐ。
| 条件 | ブランチ名の例 |
|---|---|
| 主となるIssueがある | docs/191-update-git-workflow |
| 対応するIssueがない | docs/update-git-workflow |
主となるIssueがある場合は、番号を説明の前に置く。
ブランチ名に # が含まれるとCloudflareのプレビュービルドでエラーが発生したため、番号には # を付けない。
このルールは新規ブランチに適用する。
ブランチ名を変更したPR