リリースとロールバック
本番環境へのリリース手順、タグ運用、リリースノート、ロールバックの方法
リリースの流れ
本番環境への反映は CI/CD による自動化を基本とします。
developからmainへの PR を作成し、マージする- CI とデプロイのワークフローが成功したことを Actions タブで確認する
- 必要に応じてタグを作成し、リリースノートを公開する
ブランチの運用はブランチ戦略、デプロイの設定はデプロイを参照してください。
タグ運用
タグは任意です。付ける場合は、次の命名規則に従います。 レンタルサーバーの案件など、ホスティングサービスの機能で以前のデプロイに戻せない場合は、ロールバックの基点になるため付けてください。
タグの命名規則
セマンティックバージョニング(SemVer)に準拠します。
v<major>.<minor>.<patch>
例:
v1.0.0
v1.2.3
v2.0.0-beta.1
- major: 後方互換性のない変更
- minor: 後方互換性のある機能追加
- patch: 後方互換性のあるバグ修正
タグの作成
リリース管理には、作成者・日時・メッセージが記録される注釈付きタグを使用します。
タグは、main にマージしたリリースのマージコミットに付けます。
git switch main
git pull
git tag -a v1.0.0 -m "Release version 1.0.0"
git push origin v1.0.0
タグの確認と削除
# タグの一覧を表示
git tag -l "v1.*"
# タグの詳細を表示
git show v1.0.0
# ローカルとリモートのタグを削除
git tag -d v1.0.0
git push origin --delete v1.0.0
リリースノート
リリースノートは任意です。作成する場合は、GitHub の自動生成を使います。
- GitHub の自動生成: Releases の作成画面で「Generate release notes」を使う。前回のタグ以降にマージされた PR のタイトルが一覧になり、
.github/release.ymlで PR のラベルごとに分類できる
ロールバック
デプロイ後に問題が発生した場合、影響を最小限にするため速やかにロールバックします。
git revert で取り消す(推奨)
問題のあるコミットを打ち消すコミットを作成し、通常のデプロイの流れで前の状態に戻します。
履歴を壊さずに取り消せるため、原則としてこの方法を優先してください。
main への直接 push は禁止しているため、緊急修正(hotfix)と同じ流れで PR 経由で反映します。
git switch main
git pull
git switch -c hotfix/revert-<対象>
git log --oneline
git revert -m 1 <リリースのマージコミットのハッシュ>
git push -u origin hotfix/revert-<対象>
- push したブランチから
mainへの PR を作成してマージし、本番へデプロイする mainからdevelopへの PR を作成してマージし、取り消しをdevelopにも反映する
ホスティングサービスの機能を使う
緊急時は、ホスティングサービスの機能で以前のデプロイに即座に戻します。その後、原因のコミットを git revert で取り消してください。
- Cloudflare Workers: ダッシュボードの Deployments から以前のバージョンを選んで Rollback する。または
wrangler rollbackを実行する - Cloudflare Pages: Deployments から以前の本番デプロイを選んで「Rollback to this deployment」を実行する
- Vercel: ダッシュボードから以前のデプロイを Promote する
- Netlify: デプロイ履歴から以前のバージョンを公開する
レンタルサーバーの場合
レンタルサーバーには以前のデプロイに戻す機能がありません。
前回リリースのタグをチェックアウトしてビルドし、通常と同じ方法で配信し直します。
ワークフローに workflow_dispatch の入力でタグを指定できるようにしておくと、すぐに再デプロイできます。