# バッチ設計書 8-eng/cibuild.sh

## 概要

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

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

eng/cibuild.shは、CI（継続的インテグレーション）環境でF#コンパイラの完全なビルドパイプラインを実行するためのLinux/macOS向けスクリプトである。シンボリックリンクを正しく解決した上で、eng/build.shを--ci --restore --build --pack --publishオプションで呼び出す。実行前にGitコミット情報を表示し、バイナリログ出力も有効化される。

**業務上の目的・背景**：F#コンパイラはクロスプラットフォーム対応であり、Linux/macOS環境でもCI/CDパイプラインを実行する必要がある。本スクリプトは、GitHub ActionsやAzure DevOpsのLinux/macOSエージェントから呼び出され、F#コンパイラのビルドとパッケージングを自動化する。Windows版と異なり、署名（sign）は含まれないが、リストア、ビルド、パック、公開の主要フェーズを実行する。

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

**主要な処理内容**：
1. BASH_SOURCEからスクリプトパスを取得する
2. シンボリックリンクを解決し、実際のスクリプト位置を特定する
3. ビルド対象のGitコミット情報を表示する
4. eng/build.shを--ci --restore --build --pack --publish --binaryLogオプションで呼び出す

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

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

## バッチ種別

CI/CDビルド処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| Bash | Bashシェルが利用可能であること |
| Git | Gitコマンドが利用可能であること |
| 実行権限 | スクリプトに実行権限があること（chmod +x） |
| ネットワーク | NuGetフィードおよび公開先へのアクセスが可能であること |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード | .fs/.fsproj | プロジェクトディレクトリ内のF#ソースファイル |
| ソリューションファイル | .sln | FSharp.sln |
| NuGetパッケージ | .nupkg | 依存パッケージ |
| Gitリポジトリ | .git | コミット情報の取得に使用 |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. BASH_SOURCEからスクリプトパスを取得
   └─ 現在のスクリプトファイルのパスを特定
2. シンボリックリンクの解決
   └─ -hオプションでシンボリックリンクかどうか判定
   └─ readlinkコマンドで実際のパスを取得
3. スクリプトルートディレクトリの特定
   └─ cd -P と dirname で絶対パスを取得
4. Gitコミット情報の表示
   └─ git show --no-patch --pretty=raw HEAD
5. eng/build.shの呼び出し
   └─ --ci --restore --build --pack --publish --binaryLog オプションを渡す
6. 各ビルドフェーズの実行
   └─ restore → build → pack → publish
```

### フローチャート

```mermaid
flowchart TD
    A[cibuild.sh開始] --> B[BASH_SOURCE取得]
    B --> C{シンボリックリンク?}
    C -->|Yes| D[readlinkで解決]
    D --> C
    C -->|No| E[scriptrootを特定]
    E --> F[Gitコミット情報表示]
    F --> G[eng/build.sh呼び出し]
    G --> H[restore]
    H --> I[build]
    I --> J[pack]
    J --> K[publish]
    K --> L{全フェーズ成功?}
    L -->|Yes| M[正常終了]
    L -->|No| N[エラー終了]
```

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

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

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

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

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

N/A

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

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

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド開始時 | Gitコミット情報（ハッシュ、作者、日時） |
| 進捗ログ | 各フェーズ | フェーズ名、プロジェクト名 |
| 終了ログ | ビルド終了時 | 成功/失敗ステータス |
| エラーログ | エラー発生時 | エラーコード、エラーメッセージ |

## 監視・アラート

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

## 備考

- このスクリプトはCI環境専用であり、ローカル開発にはbuild.shを使用する
- Windows環境では代わりにeng/CIBuild.cmdを使用する
- Linux/macOS版では署名（sign）は含まれない
- バイナリログは自動的に出力されるため、ビルド問題の診断が容易
- 実行前にGitコミット情報が表示されるため、ビルド対象の確認が容易
