# バッチ設計書 34-release-npm-release

## 概要

本ドキュメントは、リリースプロセスにおいてビルド、テスト、npm公開を実行するバッチ「release-npm-release」の設計仕様を定義するものである。

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

本バッチは、Babelのリリースプロセスにおいて、パッケージのビルドとテストを実行し、検証に成功したパッケージをnpmレジストリに公開する中核的な処理を実行する。

**業務上の目的・背景**：npmレジストリへのパッケージ公開はBabelプロジェクトの主要なデリバリーチャネルである。本バッチは、ビルドとテストによる品質保証を経てからパッケージを公開することで、エンドユーザーに高品質なパッケージを提供する。npm環境の認証情報を使用し、Provenance（来歴）付きでの公開を行う。

**バッチの実行タイミング**：git-versionジョブ（成功またはスキップ）およびensure-npm-packages-existジョブの成功後に実行される。always()条件により、git-versionがスキップされた場合（タグpushトリガー時）でも実行される。

**主要な処理内容**：
1. リポジトリをチェックアウト（fetch-depth: 0）
2. Node.js最新版をセットアップ
3. git-versionジョブが成功した場合、一時ブランチをチェックアウト
4. Babel Botとしてgit configを設定
5. make prepublishでビルドとテストを実行
6. yarn release-tool publish --yes --tag nextでnpmに公開

**前後の処理との関連**：git-version（成功またはスキップ）およびensure-npm-packages-existの完了後に実行。npm環境への認証にはid-token: write権限が必要。

**影響範囲**：npmレジストリに新バージョンのパッケージが公開される。全Babelユーザーがnpm install時に新バージョンを取得可能になる。

## バッチ種別

リリース処理 / パッケージ公開

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| git-versionジョブ | success または skipped であること |
| ensure-npm-packages-exist成功 | 前提ジョブが正常完了していること |
| npm環境 | environment: npm に設定された認証情報があること |
| id-token: write権限 | Provenance付き公開に必要な権限 |

### 実行可否判定

always() && (needs.git-version.result == 'success' || needs.git-version.result == 'skipped') && needs.ensure-npm-packages-exist.result == 'success' の条件を満たす場合に実行。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| branch（内部） | string | No | なし | git-versionジョブからの一時ブランチ名 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Git履歴 | Git | 全コミット履歴 |
| needs.git-version.outputs.branch | 文字列 | 一時ブランチ名（存在する場合） |
| npm環境シークレット | 環境変数 | npm認証トークン |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| npmレジストリ | パッケージ | 公開されたBabelパッケージ群 |
| 標準出力 | テキスト | ビルド・テスト・公開ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | なし（npmレジストリへの公開） |
| 出力先 | npmレジストリ（registry.npmjs.org） |
| 文字コード | 該当なし |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. リポジトリチェックアウト
   └─ actions/checkout@v4 (fetch-depth: 0)
2. Node.js最新版セットアップ
   └─ actions/setup-node@v4 (node-version: latest, check-latest: true)
3. 一時ブランチチェックアウト（git-version成功時）
   └─ git checkout $branch
4. コミッター設定
   └─ git config user.name "Babel Bot"
   └─ git config user.email "babel-bot@users.noreply.github.com"
5. ビルドとテスト
   └─ make prepublish (FORCE_COLOR=true)
6. npm公開
   └─ yarn release-tool publish --yes --tag next
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{実行条件確認}
    B -->|条件満たさず| C[スキップ]
    B -->|条件満たす| D[リポジトリチェックアウト]
    D --> E[Node.jsセットアップ]
    E --> F{git-version成功?}
    F -->|Yes| G[一時ブランチチェックアウト]
    F -->|No| H[現在のブランチ使用]
    G --> I[Babel Bot設定]
    H --> I
    I --> J[make prepublish]
    J --> K{ビルド・テスト成功?}
    K -->|No| L[エラー終了]
    K -->|Yes| M[yarn release-tool publish]
    M --> N{公開成功?}
    N -->|No| L
    N -->|Yes| O[バッチ終了]
    C --> O
    L --> O
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ビルド失敗 | make prepublishでエラー | ビルドログを確認、依存関係を検証 |
| 1 | テスト失敗 | prepublish内のテストでエラー | テストログを確認、テストを修正 |
| 1 | npm公開失敗 | 認証エラー、ネットワークエラー | npm環境シークレットを確認 |
| 1 | 重複バージョン | 既に公開済みのバージョン | バージョンを更新して再実行 |

### リトライ仕様

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

### 障害時対応

1. GitHub Actionsログでエラー内容を確認
2. ビルド・テスト失敗の場合：エラーを修正して新しいバージョンでリリース
3. npm公開失敗の場合：npm環境シークレットとネットワーク接続を確認
4. 部分的に公開された場合：手動でnpm unpublishまたはdeprecateを検討

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | パッケージ単位（各パッケージは独立して公開） |
| コミットタイミング | npm publish実行時 |
| ロールバック条件 | npm unpublish（公開後24時間以内のみ可能） |

## パフォーマンス要件

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

## 排他制御

- needs設定により、git-versionおよびensure-npm-packages-existの完了を待機
- 同時に複数のnpm-releaseが実行されることは想定されていない

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | チェックアウト時 | リポジトリ・ブランチ情報 |
| ビルドログ | make prepublish時 | ビルド進捗と結果 |
| テストログ | make prepublish時 | テスト実行結果 |
| 公開ログ | release-tool publish時 | 各パッケージの公開状況 |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

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

## 備考

- --tag next フラグにより、Babel 8が安定版になるまでは「next」タグでの公開となる
- FORCE_COLOR=true 環境変数は、supports-colorライブラリがGitHub CIでカラー出力を有効にするためのハック（chalkが4.0にバンプされるまで必要）
- id-token: write権限により、npm Provenanceが有効になり、パッケージの来歴を検証可能になる
- make prepublishには、ビルド、テスト、およびリリース前の各種チェックが含まれる
