# バッチ設計書 32-release-log-updates

## 概要

本ドキュメントは、リリースワークフローの最初のステップとして公開予定のパッケージ情報をログ出力するバッチ「release-log-updates」の設計仕様を定義するものである。

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

本バッチは、Babelのリリースプロセスにおいて、どのパッケージが公開対象となるかを事前にログ出力し、リリース担当者が確認できるようにする情報提供バッチである。

**業務上の目的・背景**：リリースプロセスの透明性を確保し、公開されるパッケージを事前に把握することで、意図しないパッケージの公開や公開漏れを防止する。また、リリース作業の監査ログとしても機能し、問題発生時のトレースを可能にする。

**バッチの実行タイミング**：Gitタグ（v*形式）のpush時、またはworkflow_dispatchによる手動実行時に実行される。手動実行時はバージョン（prerelease、8.0.0-beta.4、8.0.0-rc.1）を選択できる。

**主要な処理内容**：
1. リポジトリをチェックアウト（fetch-depth: 0で全履歴取得）
2. workflow_dispatchトリガーの場合：yarn release-tool version --dry --all でドライラン実行し、バージョン更新対象パッケージを表示
3. タグpushトリガーの場合：git diff --name-only HEAD^..HEAD で変更されたファイル一覧を表示

**前後の処理との関連**：本バッチはリリースワークフローの最初のジョブであり、後続のensure-npm-packages-exist、git-version、npm-release等のジョブと並行または前に実行される。依存関係はないため、他のジョブの成否に影響を与えない。

**影響範囲**：ログ出力のみのため、システムやデータへの直接的な影響はない。リリース判断の参考情報として利用される。

## バッチ種別

情報出力 / ログ生成

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Gitタグ形式 | v* 形式のタグがpushされていること（タグトリガーの場合） |
| バージョン選択 | prerelease、8.0.0-beta.4、8.0.0-rc.1のいずれか（手動実行の場合） |
| リポジトリアクセス | contents: read 権限があること |

### 実行可否判定

push イベント（tags: v*）または workflow_dispatch イベントで自動的に実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| version | choice | Yes（手動時） | prerelease | リリースバージョン（prerelease / 8.0.0-beta.4 / 8.0.0-rc.1） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Git履歴 | Git | fetch-depth: 0で取得した全コミット履歴 |
| package.json | JSON | 各パッケージのバージョン情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 公開対象パッケージ一覧またはファイル変更一覧 |
| GitHub Actions ログ | テキスト | ワークフロー実行ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | なし（標準出力のみ） |
| 出力先 | GitHub Actions ログ |
| 文字コード | UTF-8 |
| 区切り文字 | 改行 |

## 処理フロー

### 処理シーケンス

```
1. リポジトリチェックアウト
   └─ actions/checkout@v4 (fetch-depth: 0)
2. トリガー種別判定
   └─ github.event_name を確認
3a. workflow_dispatchの場合
   └─ yarn release-tool version --dry --all $version
3b. タグpushの場合
   └─ git diff --name-only HEAD^..HEAD
4. 結果をログ出力
   └─ GitHub Actionsログに表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[リポジトリチェックアウト]
    B --> C{トリガー種別}
    C -->|workflow_dispatch| D[release-tool version --dry]
    C -->|push tags| E[git diff HEAD^..HEAD]
    D --> F[パッケージ一覧出力]
    E --> G[変更ファイル一覧出力]
    F --> H[バッチ終了]
    G --> H
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | チェックアウト失敗 | リポジトリアクセスエラー | ネットワーク・権限を確認 |
| 1 | release-tool失敗 | yarn release-tool実行エラー | release-toolの依存関係を確認 |
| 1 | git diff失敗 | Git履歴アクセスエラー | fetch-depth設定を確認 |

### リトライ仕様

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

### 障害時対応

1. GitHub Actionsログでエラー内容を確認
2. 本バッチは情報出力のみのため、失敗しても後続ジョブに影響なし
3. 必要に応じて手動でgit diffまたはrelease-toolコマンドを実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

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

## 排他制御

特になし。他ジョブとの依存関係がなく、並行実行可能。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | チェックアウト時 | リポジトリチェックアウト情報 |
| 進捗ログ | コマンド実行時 | 実行コマンドと結果 |
| 終了ログ | バッチ終了時 | 公開対象パッケージ一覧/変更ファイル一覧 |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ失敗 | 1回 | GitHub Actions UI |

## 備考

- 本バッチはドライラン実行であり、実際のバージョン更新やパッケージ公開は行わない
- workflow_dispatch入力のdescriptionに記載の通り、マイナーバージョンは人的介入が必要なため、自動リリースはパッチバージョンまたはBabel 8プレリリースに限定される
