Skip to main content

Git のワークフロー

作業は既定ブランチから始め、作業用ブランチの変更をプルリクエスト(PR)で既定ブランチに取り込む。 GitHubのラベルはラベル運用ルールを参照する。

使用するブランチの役割​

  • 既定ブランチは、レビュー済みの変更を取り込むブランチである。 このリポジトリでは master が該当する
  • 作業用ブランチは、機能追加や不具合修正、文書の更新に使う
  • リリース用ブランチは、本番へデプロイする変更をまとめるブランチである。 このリポジトリではGitHub Actionsの本番リリースワークフローがmasterをreleaseに取り込む

本番へ配布したコミットの記録は、本番リリースの記録を参照する。

通常の開発のブランチ管理の流れ​

  1. 最新の既定ブランチから作業用ブランチを作る
  2. 変更を確認し、既定ブランチを取り込み先にしたPRを開く。 作業途中でフィードバックがほしい場合はドラフトPRを使う
  3. レビューと検証が済んだらPRをマージし、作業用ブランチを削除する

変更を段階的にレビューする場合は、作業用ブランチから子ブランチを作り、そのPRの取り込み先を親ブランチにする。 緊急の修正も既定ブランチに取り込み、本番反映は次の手順に従う。

本番反映​

本番の公開は release ブランチへの反映で行う。 Cloudflare Workers Buildsがreleaseへのpushを受けて静的ファイルをデプロイする。 master から release へのプルリクエストは使わない。 releaseはSettings → Rules → Rulesetsのreleaseルールセットで保護する。 「Require a pull request before merging」は付けない。 必須ステータスと削除禁止は残してよい。 個人リポジトリではGITHUB_TOKENはリポジトリ管理者ロールのbypassに当たらない。

手順は次のとおりである。

  1. 取り込む変更が master にマージ済みであることを確認する
  2. GitHubのActionsからワークフロー本番リリースを開く
  3. 実行ブランチにmasterを選び、Run workflowする
  4. ワークフローがmasterをreleaseにマージする
  5. 履歴を直線のまま取り込めるときはfast-forwardにする。できないときはmerge commitにする
  6. 同じ実行でタグrelease-YYYY-MM-DD-NとGitHub Releaseを作る
  7. Cloudflareの本番デプロイ完了を確認する
  8. 版情報の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

無視ファイルのひな型​

次の内容をリポジトリ直下の .gitignore にコピーする。 依存関係、ビルドの出力先、開発ツールに合わせて項目を調整する。

.gitignore
# 依存関係
/node_modules/

# ビルド成果物
/build/

# ローカルの環境変数
.env
.env.local
.env.*.local

# 作業用の一時ファイル
.tmp/

# Cursorのフックが生成する状態ファイル
/.cursor/hooks/state/

# ログとOSが生成するファイル
*.log
.DS_Store

Docusaurusを使う場合は /.docusaurus/、Storybookの静的ビルドを使う場合は /storybook-static/ を追加する。 環境変数の例を共有する場合は、値の例だけを記載した .env.example を追跡する。

Issueテンプレート​

Issueテンプレートの設定方法

要望テンプレート​

.github/ISSUE_TEMPLATE/new_idea.md
---
name: 要望テンプレート
about: 新規提案・機能要望を作成する
labels: ['draft']
---

## 背景と要望

## 対応方針

## 完了条件

## 補足

<!-- 判断に必要な情報があれば書く -->

不具合テンプレート​

.github/ISSUE_TEMPLATE/bug_report.md
---
name: 不具合テンプレート
about: 不具合報告を作成する
title: '[BUG] '
labels: ['bug']
---

## 起きていること

## 再現手順

## 期待する動作

## 補足

<!-- 発生した環境など、再現や判断に必要な情報があれば書く -->

Pull Request テンプレート​

要約には変更内容とその理由を書く。 判断してほしい点や確認結果があれば、「レビュー時の補足」にまとめる。

AIに確認してほしい観点は、<details> にまとめる。 PR本文のMarkdownを受け取るAIレビューでは、折りたたまれた観点も参照できる。 リポジトリへAIレビューを導入する手順はAIによるPRレビューの導入を参照する。

.github/pull_request_template.md
## 要約

<!-- 何を変えたか、なぜ変えたかを1〜3文で書く。関連Issueを閉じる場合は Closes #番号 を添える -->

## レビュー時の補足

<!-- 判断してほしい点、注意事項、検証結果、未確認事項など、レビューに関係するものだけを書く。なければこの節を省略できる -->

<details>
<summary>AIレビュー向けの確認観点</summary>

- PRの目的と実際の差分が一致しているか
- 変更によって既存の動作や利用箇所に問題が生じないか
- 変更箇所の境界条件や失敗時の処理に抜けがないか

<!-- このPRで特に確認してほしい挙動や箇所があれば追記する -->

</details>