# バッチ設計書 1-Build.cmd

## 概要

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

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

Build.cmdは、F#コンパイラおよび関連ツールのビルドを実行するためのWindows向けエントリーポイントスクリプトである。PowerShellスクリプト（eng/Build.ps1）をラップし、restoreおよびbuildオプションを指定して呼び出すことで、プロジェクトの依存関係の復元とビルドを一括で実行する。

**業務上の目的・背景**：F#コンパイラの開発において、開発者がローカル環境で簡単にビルドを実行できる手段を提供する。コマンドラインから単一のコマンドでビルド全体を実行できるようにすることで、開発効率を向上させ、ビルド手順の標準化を実現する。

**バッチの実行タイミング**：開発者が手動でビルドを行う際に随時実行される。コード変更後の動作確認、プルリクエスト作成前の検証、ローカル開発環境でのテスト準備など、開発サイクル全体を通じて頻繁に使用される。

**主要な処理内容**：
1. PowerShellの実行ポリシーをByPassに設定し、スクリプト実行を許可する
2. eng/Build.ps1スクリプトを-restoreおよび-buildオプション付きで呼び出す
3. コマンドライン引数をそのまま後続のスクリプトに渡す

**前後の処理との関連**：このバッチは開発ワークフローの起点となる。事前にソースコードのチェックアウトが必要。ビルド成功後はテスト実行（Test.cmd）やパッケージング処理へ移行可能。

**影響範囲**：artifacts/binディレクトリ配下にビルド成果物が生成される。NuGetパッケージキャッシュが更新される場合がある。

## バッチ種別

ビルド処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| PowerShell | PowerShellが利用可能であること |
| Visual Studio | MSBuildエンジンとしてVSを使用する場合は必要 |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード | .fs/.fsproj | プロジェクトディレクトリ内のF#ソースファイル |
| ソリューションファイル | .sln | FSharp.slnまたはVisualFSharp.sln |
| NuGetパッケージ | .nupkg | 依存パッケージ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/bin | DLL/EXE | コンパイル済みバイナリ |
| artifacts/obj | 中間ファイル | ビルド中間成果物 |
| artifacts/log | .binlog | バイナリログファイル |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. コマンドライン引数の受け取り
   └─ %*で渡されたすべての引数を取得
2. PowerShellの起動
   └─ ExecutionPolicy ByPass、NoProfileオプションで実行
3. Build.ps1の呼び出し
   └─ -restore -build オプションと追加引数を渡す
4. ビルド処理の実行
   └─ 依存関係の復元とプロジェクトのビルド
```

### フローチャート

```mermaid
flowchart TD
    A[Build.cmd開始] --> B[コマンドライン引数取得]
    B --> C[PowerShell起動]
    C --> D[eng/Build.ps1呼び出し]
    D --> E{ビルド成功?}
    E -->|Yes| F[正常終了]
    E -->|No| G[エラー終了]
```

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

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

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

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

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ビルドエラー | コンパイルエラー発生時 | エラーメッセージを確認しソースコードを修正 |
| 1 | 依存関係エラー | パッケージ復元失敗時 | ネットワーク接続を確認、NuGetソースを確認 |
| 1 | 環境エラー | .NET SDK未インストール時 | 適切なSDKをインストール |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、原因を特定する
2. バイナリログ（artifacts/log/*.binlog）を確認する
3. 必要に応じて依存関係を再復元する（Restore.cmd）
4. 問題が解決しない場合はartifactsディレクトリを削除して再実行

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

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

## パフォーマンス要件

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

## 排他制御

同一ディレクトリでの同時実行は推奨されない。MSBuildのnode reuseが有効な場合、複数ビルドが干渉する可能性がある。

## ログ出力

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

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | N/A（ローカル実行） | N/A |
| エラー件数 | N/A | N/A |

## 備考

- このスクリプトはプロジェクトルートから実行することを想定している
- Linux/macOS環境では代わりにbuild.shを使用する
- 追加オプションについてはeng/Build.ps1の-helpを参照
