# バッチ設計書 4-build

## 概要

本ドキュメントは、GitHub Actions CI/CDパイプラインにおけるBabelアーティファクトビルドバッチの設計仕様を定義する。

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

Babelプロジェクト全体のビルドを実行し、後続のテスト・リントジョブで使用するアーティファクトを生成するバッチ処理である。コンパイル済みパッケージ、README、.npmignoreファイルの生成を含む。

**業務上の目的・背景**：Babelはモノレポ構成で100以上のパッケージを管理している。各パッケージのTypeScriptソースコードをJavaScriptにコンパイルし、後続のテストやリント処理で使用できる状態にする必要がある。本バッチは一度ビルドを行い、アーティファクトとして保存することで、後続ジョブでのビルド重複を防ぎ、CI全体の効率化を実現する。

**バッチの実行タイミング**：リポジトリへのpush時およびプルリクエスト作成時に自動実行される。prepare-yarn-cacheジョブの完了後に実行される。

**主要な処理内容**：
1. リポジトリのチェックアウトとNode.jsセットアップ
2. make build-standalone-ciでBabelアーティファクトをビルド（BABEL_9_BREAKING=false）
3. Makefile.jsのパック処理
4. README自動生成（make generate-readme）
5. .npmignoreファイル生成
6. フィクスチャークリーンアップ
7. Git差分チェック（未コミット変更の検出）
8. ビルドアーティファクトのアップロード

**前後の処理との関連**：prepare-yarn-cacheジョブに依存する。lint、test-coverage、test、test-windows-macなどの後続ジョブはこのバッチが生成したアーティファクトをダウンロードして使用する。

**影響範囲**：packages/、codemods/、eslint/配下のlib/ディレクトリ生成、GitHub Actionsアーティファクトストレージ。

## バッチ種別

ビルド処理 / CI/CD

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（イベント駆動） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | push / pull_request イベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| prepare-yarn-cache | キャッシュ準備ジョブが正常完了していること |
| Makefile | build-standalone-ciターゲットが定義されていること |
| TypeScript | ソースコードがコンパイル可能な状態であること |

### 実行可否判定

GitHub Actionsのneeds設定に基づき、prepare-yarn-cacheジョブの正常完了後に自動実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| BABEL_ENV | string | No | test-legacy | Babel環境設定 |
| BABEL_9_BREAKING | boolean | No | false | Babel 9破壊的変更フラグ |
| STRIP_BABEL_VERSION_FLAG | boolean | No | true | バージョンフラグ除去 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/src | TypeScript | Babelパッケージのソースコード |
| codemods/*/src | TypeScript | Codemodのソースコード |
| eslint/*/src | TypeScript | ESLintプラグインのソースコード |
| Makefile | Makefile | ビルドターゲット定義 |
| Makefile.source.ts | TypeScript | Makefile.jsの元ソース |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/*/lib | JavaScript | コンパイル済みパッケージ |
| codemods/*/lib | JavaScript | コンパイル済みCodemod |
| eslint/*/lib | JavaScript | コンパイル済みESLintプラグイン |
| packages/babel-standalone/*.js | JavaScript | babel-standaloneビルド |
| packages/babel-runtime | JavaScript | ランタイムヘルパー |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| アーティファクト名 | babel-artifact |
| 保存期間 | 5日間 |
| 文字コード | UTF-8 |
| 形式 | JavaScript / JSON |

## 処理フロー

### 処理シーケンス

```
1. Checkout code
   └─ actions/checkout@v4でリポジトリをチェックアウト
2. Use Node.js latest
   └─ actions/setup-node@v4でNode.js 25.6.1をセットアップ
3. Build babel artifacts
   └─ make -j build-standalone-ci（並列ビルド）
   └─ BABEL_ENV=test-legacy、BABEL_9_BREAKING=false
4. Build Makefile.js
   └─ node ./scripts/pack-script.ts
5. Generate readmes
   └─ make generate-readme
6. Generate .npmignore
   └─ node scripts/generators/npm-ignore.ts
7. Cleanup fixtures
   └─ node scripts/cleanup-fixtures.ts
8. Ensure cwd does not contain uncommitted changes
   └─ node ./scripts/assert-dir-git-clean.ts
9. Upload artifact
   └─ actions/upload-artifact@v4でアーティファクト保存
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[actions/checkout: リポジトリ取得]
    B --> C[actions/setup-node: Node.js セットアップ]
    C --> D[make build-standalone-ci 実行]
    D --> E{ビルド成功?}
    E -->|失敗| F[バッチ失敗終了]
    E -->|成功| G[Makefile.js パック処理]
    G --> H[README 生成]
    H --> I[.npmignore 生成]
    I --> J[フィクスチャークリーンアップ]
    J --> K[Git差分チェック]
    K --> L{差分なし?}
    L -->|あり| F
    L -->|なし| M[アーティファクトアップロード]
    M --> N[バッチ正常終了]
```

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

### テーブル別操作詳細

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| EXIT_1 | ビルドエラー | make build-standalone-ci失敗時 | ビルドログを確認し、ソースコードを修正 |
| EXIT_1 | TypeScriptエラー | コンパイルエラー時 | 型エラーを修正 |
| EXIT_1 | Git差分エラー | 未コミット変更存在時 | 変更をコミットまたはビルド出力を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（GitHub Actionsデフォルト） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. GitHub Actionsのジョブログを確認
2. ビルドエラーの場合：make build-standalone-ciの出力を分析
3. Git差分エラーの場合：assert-dir-git-clean.tsの出力を確認
4. ローカル環境で`make build`を実行して再現・修正

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイル操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 100以上のパッケージのビルド |
| 目標処理時間 | 10分以内 |
| メモリ使用量上限 | ubuntu-latestランナーのデフォルト |

## 排他制御

concurrency設定により、同一ワークフロー・同一リファレンスの実行は1つに制限される。make -jオプションにより並列ビルドを実行。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ジョブ開始時 | GitHub Actions自動出力 |
| ビルドログ | make実行時 | コンパイル進捗、エラー詳細 |
| 生成ログ | 各スクリプト実行時 | 生成ファイル情報 |
| 終了ログ | ジョブ終了時 | 成功/失敗ステータス |
| アーティファクトログ | アップロード時 | アップロードファイル一覧 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ成功率 | 100% | GitHubステータスチェック |
| 処理時間 | 15分超過 | GitHub Actions通知 |

## 備考

- BABEL_9_BREAKING=falseでBabel 8互換ビルドを生成（Babel 9用は別ジョブ）
- アーティファクトは5日間保存され、後続ジョブでダウンロード可能
- assert-dir-git-clean.tsはビルド後の未コミット変更を検出し、生成ファイルの一貫性を保証
- node_modulesディレクトリはアーティファクトから除外される
