# バッチ設計書 1-build.sh

## 概要

本ドキュメントは、Avaloniaプロジェクトにおける Linux/macOS 用メインビルドスクリプト `build.sh` のバッチ設計書です。

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

このバッチスクリプトは、Linux/macOS環境においてAvaloniaフレームワークをビルドするためのエントリーポイントとして機能します。.NET SDKの検出・必要に応じた自動インストールを行い、Nukeビルドシステムを実行してプロジェクト全体のビルドを行います。

**業務上の目的・背景**：Avaloniaは.NETベースのクロスプラットフォームUIフレームワークであり、Linux/macOS環境での開発者が簡単にプロジェクトをビルドできる手段を提供する必要があります。このスクリプトは、.NET SDK環境が未構築の環境でも自動的に適切なバージョンをインストールし、一貫したビルドプロセスを実現します。

**バッチの実行タイミング**：開発者による手動実行、またはCI/CDパイプライン（Azure Pipelines）からの自動実行時に使用されます。プルリクエスト作成時、コードプッシュ時、リリースビルド時などに実行されます。

**主要な処理内容**：
1. Bashバージョンの表示
2. スクリプトディレクトリの特定とビルド設定の初期化
3. グローバルにインストールされた.NET SDKの検出
4. .NET SDKが未インストールまたはバージョン不一致の場合、公式インストールスクリプトをダウンロードして実行
5. global.jsonで指定されたバージョンの.NET SDKをインストール
6. nukebuild/_build.csprojのビルド
7. Nukeビルドシステムの実行（コマンドライン引数を渡す）

**前後の処理との関連**：このスクリプトは最上位のエントリーポイントであり、後続のNukeターゲット（Clean、Compile、RunTestsなど）を呼び出すための起点となります。build.cmdからも間接的に呼び出される可能性があります。

**影響範囲**：ローカルの.nuke/tempディレクトリへの一時ファイル作成、nukebuildプロジェクトのビルド成果物、およびNukeターゲットで指定された出力ディレクトリ全般に影響を与えます。

## バッチ種別

ビルドスクリプト / 開発支援ツール

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行またはCI/CDトリガー） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動 / CI/CDパイプライン（Azure Pipelines） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| OS | Linux または macOS |
| Bash | バージョン3.0以上 |
| curl | インストール済み（.NET SDKダウンロード用） |
| インターネット接続 | .NET SDKダウンロード時に必要（既存インストール時は不要） |
| perl | global.jsonパース用（.NET SDKダウンロード時に必要） |

### 実行可否判定

- Bash環境で実行可能であること
- スクリプトに実行権限があること（chmod +x build.sh）
- pipefailオプションがサポートされていること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $@ | string[] | No | - | Nukeビルドシステムに渡される任意のコマンドライン引数（ターゲット名、オプションなど） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| global.json | JSON | .NET SDKバージョン指定ファイル |
| nukebuild/_build.csproj | MSBuild Project | Nukeビルドプロジェクト定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | Bashバージョン、.NET SDKバージョン、ビルドログ |
| .nuke/temp/ | ディレクトリ | 一時ファイル（dotnet-install.sh、インストールされた.NET SDK） |
| Nukeターゲット依存 | 各種 | 実行されるNukeターゲットに応じた成果物 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | dotnet-install.sh（一時ファイル） |
| 出力先 | .nuke/temp/ |
| 文字コード | N/A（バイナリ/シェルスクリプト） |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. 環境設定
   └─ pipefailを有効化し、スクリプトディレクトリを特定
2. 設定変数の初期化
   └─ BUILD_PROJECT_FILE、TEMP_DIRECTORY、DOTNET関連環境変数を設定
3. .NET SDK検出
   └─ グローバルにインストールされたdotnetコマンドの存在確認
4. .NET SDK未検出時の処理
   └─ dotnet-install.shをダウンロードし、global.jsonのバージョンに基づいてインストール
5. SDKバージョン表示
   └─ 使用する.NET SDKのバージョンを標準出力に表示
6. Nukeプロジェクトビルド
   └─ nukebuild/_build.csprojをdotnet buildでコンパイル
7. Nukeビルドシステム実行
   └─ dotnet runでNukeビルドを実行し、コマンドライン引数を渡す
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[環境設定初期化]
    B --> C{dotnetコマンド存在?}
    C -->|あり| D[グローバルdotnetを使用]
    C -->|なし| E[dotnet-install.shダウンロード]
    E --> F{global.json存在?}
    F -->|あり| G[指定バージョンをインストール]
    F -->|なし| H[Currentチャンネルをインストール]
    G --> I[ローカルdotnetを使用]
    H --> I
    D --> J[SDKバージョン表示]
    I --> J
    J --> K[_build.csprojをビルド]
    K --> L[Nukeビルドシステム実行]
    L --> M[スクリプト終了]
```

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

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

本バッチはデータベース操作を行いません。

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非ゼロ終了 | コマンド失敗 | 任意のコマンドが失敗した場合（pipefailにより検出） | エラーメッセージを確認し、原因を特定 |
| 1 | ネットワークエラー | dotnet-install.shダウンロード失敗 | インターネット接続を確認 |
| 1 | インストールエラー | .NET SDKインストール失敗 | 権限、ディスク容量を確認 |
| 1 | ビルドエラー | dotnet buildまたはdotnet run失敗 | ビルドログを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（スクリプト内でのリトライ機能はなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. エラーメッセージを確認し、失敗したコマンドを特定
2. ネットワーク接続の確認（.NET SDKダウンロード時）
3. ディスク容量の確認
4. .nuke/tempディレクトリを削除して再実行
5. global.jsonの.NET SDKバージョンが有効か確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベース操作なし） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 初回実行：5-15分（SDK DL含む）、2回目以降：1-10分 |
| メモリ使用量上限 | ビルドプロジェクトに依存 |

## 排他制御

同一ディレクトリでの複数同時実行は推奨されません。ビルド成果物の競合が発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | スクリプト開始時 | Bashバージョン情報 |
| 進捗ログ | SDK検出・インストール時 | .NET SDKバージョン情報 |
| 終了ログ | ビルド完了時 | Nukeビルド出力 |
| エラーログ | エラー発生時 | コマンドのエラー出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 実行時間 | CI/CDジョブタイムアウト設定に依存 | Azure Pipelines通知 |
| 終了コード | 非ゼロ | Azure Pipelines通知 |

## 備考

- `set -eo pipefail` により、パイプライン内のいずれかのコマンドが失敗した場合にスクリプト全体が即座に終了します
- 環境変数 `DOTNET_CLI_TELEMETRY_OPTOUT=1` により、.NET CLIのテレメトリが無効化されます
- 環境変数 `DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1` により、初回実行時のNuGetパッケージキャッシュ生成がスキップされます
- 環境変数 `DOTNET_MULTILEVEL_LOOKUP=0` により、グローバルインストールの.NET SDKの探索が無効化されます
