# バッチ設計書 7-eng/CIBuild.cmd

## 概要

本ドキュメントは、F#コンパイラプロジェクトのWindows環境向けCI用フルビルドスクリプト「eng/CIBuild.cmd」の設計仕様を記載する。

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

eng/CIBuild.cmdは、CI（継続的インテグレーション）環境でF#コンパイラの完全なビルドパイプラインを実行するためのWindows向けスクリプトである。PowerShellスクリプト（eng/Build.ps1）をラップし、restore、build、bootstrap、pack、sign、publishの全フェーズを一括で実行する。バイナリログ出力も有効化されており、ビルド問題の診断に活用できる。

**業務上の目的・背景**：CI/CD環境では、コードの変更がリポジトリにプッシュされるたびに自動的にビルド、テスト、パッケージングを行う必要がある。本スクリプトは、Azure DevOpsやGitHub ActionsなどのCIシステムから呼び出され、F#コンパイラの公式ビルドを生成する。ブートストラップコンパイラの構築、NuGetパッケージの作成、署名、成果物の公開まで一貫して実行することで、リリース品質のビルドを自動化する。

**バッチの実行タイミング**：CIパイプラインで自動的にトリガーされる。プルリクエストのマージ時、メインブランチへのコミット時、リリースブランチでのビルド時など、CI/CDワークフローの一部として実行される。

**主要な処理内容**：
1. PowerShellの実行ポリシーをRemoteSignedに設定する
2. eng/Build.ps1を-ciフラグ付きで呼び出す
3. restore: 依存関係の復元
4. build: ソリューションのビルド
5. bootstrap: ブートストラップコンパイラの構築
6. pack: NuGetパッケージの作成
7. sign: バイナリの署名
8. publish: 成果物の公開
9. binaryLog: 診断用バイナリログの出力

**前後の処理との関連**：このバッチはCIパイプラインの中核となる。実行前にソースコードのチェックアウトが必要。実行後はテストジョブ、成果物のアップロード、デプロイジョブが続く。

**影響範囲**：artifacts配下に全ビルド成果物が生成される。NuGetパッケージ、署名済みバイナリ、バイナリログが出力される。

## バッチ種別

CI/CDビルド処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベントドリブン |
| 実行時刻 | CIトリガー時 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | CI（プッシュ/PR） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| PowerShell | PowerShellが利用可能であること |
| Visual Studio | MSBuildおよび署名ツールに必要 |
| ネットワーク | NuGetフィードおよび公開先へのアクセスが可能であること |

### 実行可否判定

特別な実行可否判定ロジックはない。前提条件が満たされていれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| %* | string | No | - | Build.ps1に渡される追加のコマンドライン引数 |
| -configuration | string | No | Debug | ビルド構成（Debug/Release） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード | .fs/.fsproj | プロジェクトディレクトリ内のF#ソースファイル |
| ソリューションファイル | .sln | VisualFSharp.sln |
| NuGetパッケージ | .nupkg | 依存パッケージ |
| 署名証明書 | 環境変数 | CI環境で提供される署名用証明書 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/bin | DLL/EXE | コンパイル済みバイナリ |
| artifacts/packages | .nupkg | NuGetパッケージ |
| artifacts/log | .binlog | バイナリログファイル |
| artifacts/VSSetup | .vsix | Visual Studio拡張機能 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | Build.*.binlog（バイナリログ） |
| 出力先 | artifacts/log |
| 文字コード | バイナリ |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. コマンドライン引数の受け取り
   └─ %*で渡されたすべての引数を取得
2. PowerShellの起動
   └─ ExecutionPolicy RemoteSigned、NoProfileオプションで実行
3. Build.ps1の呼び出し
   └─ -ci -restore -build -bootstrap -pack -sign -publish -binaryLog オプションを渡す
4. 依存関係の復元（restore）
   └─ NuGetパッケージの復元
5. ブートストラップコンパイラの構築（bootstrap）
   └─ proto.projのビルド
6. ソリューションのビルド（build）
   └─ VisualFSharp.slnのビルド
7. パッケージ作成（pack）
   └─ NuGetパッケージの生成
8. 署名（sign）
   └─ バイナリへの署名
9. 公開（publish）
   └─ 成果物の公開
```

### フローチャート

```mermaid
flowchart TD
    A[CIBuild.cmd開始] --> B[PowerShell起動]
    B --> C[eng/Build.ps1呼び出し]
    C --> D[restore]
    D --> E[bootstrap]
    E --> F[build]
    F --> G[pack]
    G --> H[sign]
    H --> I[publish]
    I --> J{全フェーズ成功?}
    J -->|Yes| K[正常終了]
    J -->|No| L[エラー終了]
```

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

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

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

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

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ビルドエラー | コンパイルエラー発生時 | エラーメッセージを確認しソースコードを修正 |
| 1 | 依存関係エラー | パッケージ復元失敗時 | ネットワーク接続を確認 |
| 1 | 署名エラー | 署名証明書が利用できない | 証明書設定を確認 |
| 1 | 公開エラー | 公開先への接続失敗 | ネットワーク設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. バイナリログ（*.binlog）を確認し、失敗したフェーズを特定する
2. CI環境のログを確認する
3. 必要に応じてローカルで再現テストを行う
4. 環境固有の問題の場合はCIインフラチームに連絡

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のCIビルドセッション |
| 目標処理時間 | 環境依存（通常20-60分） |
| メモリ使用量上限 | 環境依存 |

## 排他制御

CIエージェント上での同時実行は通常CIシステムによって制御される。同一ワークスペースでの同時実行は推奨されない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド開始時 | ソリューション名、構成情報、環境変数 |
| 進捗ログ | 各フェーズ | フェーズ名、プロジェクト名 |
| 終了ログ | ビルド終了時 | 成功/失敗ステータス、所要時間 |
| エラーログ | エラー発生時 | エラーコード、エラーメッセージ、スタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 環境依存 | CIシステム |
| ビルド失敗 | 即時 | PRオーナー/開発チーム |

## 備考

- このスクリプトはCI環境専用であり、ローカル開発にはBuild.cmdを使用する
- Linux/macOS環境では代わりにeng/cibuild.shを使用する
- バイナリログは自動的に出力されるため、ビルド問題の診断が容易
- 署名はCI環境でのみ有効であり、署名証明書が必要
