# バッチ設計書 36-release-github-push

## 概要

本ドキュメントは、リリースプロセスにおいてリリースコミットをmainブランチにプッシュするバッチ「release-github-push」の設計仕様を定義するものである。

### 本バッチの処理概要

本バッチは、Babelのリリースプロセスの最終ステップとして、CHANGELOG.mdを更新し、リリースコミットをmainブランチにプッシュし、一時ブランチを削除する処理を実行する。

**業務上の目的・背景**：リリースプロセスで作成された一時ブランチの変更を正式にmainブランチに反映し、CHANGELOG.mdを最新の状態に更新することで、リリース履歴を永続化する。また、一時ブランチを削除してリポジトリをクリーンな状態に保つ。

**バッチの実行タイミング**：npm-releaseジョブ成功、github-releaseジョブ成功、かつmainブランチからのリリースである場合に実行される。git-versionジョブの完了も待機する。

**主要な処理内容**：
1. リポジトリをチェックアウト（fetch-depth: 0）
2. git-versionジョブが成功した場合、一時ブランチをチェックアウト
3. github-releaseジョブで生成されたCHANGELOGをCHANGELOG.mdに追記
4. CHANGELOG.md変更をコミット（[skip ci]付き）
5. mainブランチにプッシュ
6. 一時ブランチを削除

**前後の処理との関連**：npm-release、github-release、git-versionの3ジョブの完了を待つ。github-releaseのoutputs（changelog、version、is-main）を使用する。これがリリースワークフローの最終ジョブとなる。

**影響範囲**：mainブランチにCHANGELOG.mdの更新コミットがプッシュされる。一時ブランチが削除される。

## バッチ種別

リリース処理 / バージョン管理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動 |
| 実行時刻 | 該当なし（イベント発生時） |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | push（tags: v*）/ workflow_dispatch（リリースワークフロー内） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| npm-release成功 | npm公開が正常完了していること |
| github-release成功 | GitHubリリースドラフトが作成されていること |
| is-main=true | mainブランチからのリリースであること |
| contents: write権限 | mainブランチへのプッシュに必要な権限 |

### 実行可否判定

always() && needs.npm-release.result == 'success' && needs.github-release.result == 'success' && needs.github-release.outputs.is-main の条件を満たす場合に実行。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| changelog（内部） | string | Yes | - | github-releaseジョブで生成されたCHANGELOG |
| version（内部） | string | Yes | - | リリースバージョン |
| branch（内部） | string | No | - | 一時ブランチ名（git-version成功時） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| needs.github-release.outputs.changelog | 文字列 | 生成されたCHANGELOG |
| needs.github-release.outputs.version | 文字列 | リリースバージョン |
| needs.git-version.outputs.branch | 文字列 | 一時ブランチ名 |
| CHANGELOG.md | Markdown | 既存のCHANGELOGファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| mainブランチ | Git | CHANGELOG.md更新コミット |
| 標準出力 | テキスト | プッシュ結果ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | CHANGELOG.md |
| 出力先 | リポジトリルート |
| 文字コード | UTF-8 |
| 区切り文字 | Markdown形式 |

## 処理フロー

### 処理シーケンス

```
1. リポジトリチェックアウト
   └─ actions/checkout@v4 (fetch-depth: 0)
2. 一時ブランチチェックアウト（git-version成功時）
   └─ git checkout $branch
3. CHANGELOG.md更新
   └─ babel/actions/update-changelog@v2
4. コミット作成
   └─ git add CHANGELOG.md
   └─ git commit -m "Add $version to CHANGELOG.md [skip ci]"
5. mainブランチにプッシュ
   └─ git push HEAD:main --follow-tags
6. 一時ブランチ削除（git-version成功時）
   └─ git push :$branch
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{実行条件確認}
    B -->|条件満たさず| C[スキップ]
    B -->|条件満たす| D[リポジトリチェックアウト]
    D --> E{git-version成功?}
    E -->|Yes| F[一時ブランチチェックアウト]
    E -->|No| G[現在のブランチ使用]
    F --> H[CHANGELOG.md更新]
    G --> H
    H --> I[git add CHANGELOG.md]
    I --> J[コミット作成]
    J --> K[mainにプッシュ]
    K --> L{git-version成功?}
    L -->|Yes| M[一時ブランチ削除]
    L -->|No| N[バッチ終了]
    M --> N
    C --> N
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | プッシュ失敗 | 認証エラー、保護ブランチルール | GITHUB_TOKEN権限とブランチ保護設定を確認 |
| 1 | コミット失敗 | CHANGELOG.md変更なし | 既にCHANGELOGが更新されているか確認 |
| 1 | ブランチ削除失敗 | ブランチが既に削除されている | 手動確認は不要（正常終了扱い可） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

1. GitHub Actionsログでエラー内容を確認
2. プッシュ失敗の場合：手動でCHANGELOG.mdを更新してプッシュ
3. 一時ブランチが残っている場合：手動で削除 `git push origin :release/temp/v{version}`
4. mainブランチの保護ルールを一時的に緩和して再実行

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | Git操作全体 |
| コミットタイミング | git push実行時 |
| ロールバック条件 | プッシュ前にエラーが発生した場合 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1リリース |
| 目標処理時間 | 2分以内 |
| メモリ使用量上限 | 該当なし（CI環境依存） |

## 排他制御

- needs設定により、npm-release、github-release、git-versionの完了を待機
- mainブランチへの直接プッシュとなるため、ブランチ保護ルールの設定に依存

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | チェックアウト時 | リポジトリ・ブランチ情報 |
| 進捗ログ | 各ステップ実行時 | CHANGELOG更新内容、コミットメッセージ |
| 終了ログ | バッチ終了時 | プッシュ結果、削除されたブランチ |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ失敗 | 1回 | GitHub Actions UI |
| 実行時間 | 5分 | GitHub Actions UI |

## 備考

- コミットメッセージに [skip ci] を含めることで、CHANGELOG更新コミットによるCIトリガーを回避
- Babel Botとしてコミットを作成（user.name="Babel Bot", user.email="babel-bot@users.noreply.github.com"）
- --no-verify フラグでpre-commitフックをスキップ
- --quiet フラグでコミット出力を抑制
- 一時ブランチの削除は、git-versionジョブが成功した場合（workflow_dispatchトリガー時）のみ実行される
