# バッチ設計書 19-release

## 概要

本ドキュメントは、CoffeeScriptプロジェクトにおける`release`タスクの設計書です。このバッチは、CoffeeScriptのリリース準備に必要な一連のタスクを一括実行する統合タスクです。

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

このバッチは、CoffeeScriptの新バージョンをリリースする際に必要な全ての準備作業を自動化します。依存関係の更新、コンパイラのビルド、テスト実行、ブラウザ版の生成、ドキュメントの生成までを一括で実行します。これにより、リリース作業の手順漏れを防ぎ、品質を確保します。

**業務上の目的・背景**：CoffeeScriptの新バージョンをリリースする際、複数のビルド・テスト・ドキュメント生成タスクを正しい順序で実行する必要があります。このバッチを使用することで、これらの作業を一括で実行でき、手動実行による手順漏れやミスを防止できます。また、全てのテストが通過することを確認してからドキュメントを生成するため、品質が保証されます。

**バッチの実行タイミング**：新バージョンのリリース準備時に手動で実行します。通常、バージョン番号の更新後、GitHubへのプッシュ前に実行します。

**主要な処理内容**：
1. `npm install --silent`で依存関係を更新
2. `cake build:full`でコンパイラを2回ビルドし、テストを実行（自己ビルドの検証）
3. `cake build:browser`でブラウザ用コンパイラを生成
4. `cake doc:test`でブラウザテストページを生成
5. `cake test:browser:node`でレガシーブラウザコンパイラをNode環境でテスト
6. `cake test:browser`でモダンブラウザコンパイラをヘッドレスブラウザでテスト
7. `cake test:integrations`で他ライブラリとの統合テストを実行
8. `cake doc:site`でWebサイトドキュメントを生成
9. `cake doc:source`でアノテーション付きソースドキュメントを生成

**前後の処理との関連**：このバッチは他の多くのタスクを呼び出す統合タスクです。事前にバージョン番号の更新（package.json）が必要な場合があります。完了後、GitHubへのプッシュとnpm publishを行います。

**影響範囲**：プロジェクト全体に影響します。`lib/`、`docs/`ディレクトリの内容が更新されます。

## バッチ種別

リリース準備 / 統合タスク

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（リリース時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.jsがインストールされていること |
| npm | npmが利用可能であること |
| ネットワーク接続 | npm installのためのネットワーク接続 |
| Puppeteer | ブラウザテスト用にChromiumがダウンロード可能であること |

### 実行可否判定

- プロジェクトルートにpackage.jsonが存在すること
- 全てのソースファイルが正常にコンパイル可能であること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数なし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| package.json | JSON | プロジェクト設定・依存関係 |
| src/*.coffee | CoffeeScript | コンパイラソースファイル |
| test/*.coffee | CoffeeScript | テストファイル |
| documentation/** | 各種 | ドキュメントソース |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| lib/coffeescript/*.js | JavaScript | コンパイル済みコンパイラ |
| lib/coffeescript-browser-compiler-*/*.js | JavaScript | ブラウザ用コンパイラ |
| docs/vX/*.html | HTML | Webサイトドキュメント |
| docs/vX/annotated-source/*.html | HTML | アノテーション付きソース |
| docs/vX/test.html | HTML | ブラウザテストページ |
| docs/vX/browser-compiler-*/*.js | JavaScript | ブラウザ用コンパイラ（docs） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 各タスクに依存 |
| 出力先 | lib/、docs/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. npm install --silent
   └─ 依存パッケージを最新化
2. cake build:full
   └─ コンパイラを2回ビルドし、自己ビルドを検証、テスト実行
3. cake build:browser
   └─ ブラウザ用コンパイラ（レガシー・モダン）を生成
4. cake doc:test
   └─ ブラウザテストページを生成
5. cake test:browser:node
   └─ レガシーブラウザコンパイラをNode環境でテスト
6. cake test:browser
   └─ モダンブラウザコンパイラをPuppeteerでテスト
7. cake test:integrations
   └─ Webpack等との統合テスト実行
8. cake doc:site
   └─ Webサイトドキュメントを生成
9. cake doc:source
   └─ アノテーション付きソースドキュメントを生成
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[npm install --silent]
    B --> C[cake build:full]
    C --> D{テスト成功?}
    D -->|いいえ| E[エラー終了]
    D -->|はい| F[cake build:browser]
    F --> G[cake doc:test]
    G --> H[cake test:browser:node]
    H --> I{テスト成功?}
    I -->|いいえ| E
    I -->|はい| J[cake test:browser]
    J --> K{テスト成功?}
    K -->|いいえ| E
    K -->|はい| L[cake test:integrations]
    L --> M{テスト成功?}
    M -->|いいえ| E
    M -->|はい| N[cake doc:site]
    N --> O[cake doc:source]
    O --> P[バッチ終了]
```

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

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

該当なし（ファイルシステム操作のみ）

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | npm installエラー | 依存パッケージのインストール失敗 | ネットワーク接続を確認 |
| 1 | ビルドエラー | コンパイルエラー | ソースコードを修正 |
| 1 | テスト失敗 | テストケースが失敗 | テストまたはソースを修正 |

### リトライ仕様

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

### 障害時対応

- いずれかのステップで失敗した場合、`execSync`により処理が停止する
- 失敗したステップを特定し、個別に修正・再実行
- 修正後、`cake release`を再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし（部分的に生成されたファイルは残る） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 複数タスクの連続実行 |
| 目標処理時間 | 数分〜10分程度 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行：不可
- ロック仕様：なし

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 各タスクログ | 各タスク実行時 | 各タスク固有のログ |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

- `execSync`で同期的に実行されるため、各タスクは順番に実行される
- `stdio: 'inherit'`により、各タスクの出力がそのままコンソールに表示される
- 全てのテストに合格しないとドキュメント生成に進まない
- npm publishやgit操作は含まれていないため、別途手動で実行する必要がある
- 実行時間は環境により異なるが、数分〜10分程度かかる
