# バッチ設計書 29-build-to-cache.sh

## 概要

本ドキュメントは、Avalonia UIフレームワークの「build-to-cache.sh」スクリプトの設計を記述したものである。このスクリプトは、ローカルNuGetキャッシュへのビルドを簡易実行するためのシェルスクリプトである。

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

build-to-cache.shは、NukeビルドシステムのBuildToNuGetCacheターゲットを簡単に実行するためのラッパースクリプトである。開発者がローカル環境でAvaloniaをビルドし、即座にテストできるようにする。

**業務上の目的・背景**：Avalonia UIフレームワークの開発者が、ローカルで行った変更を他のプロジェクトでテストする際、BuildToNuGetCacheターゲットを直接実行するには長いコマンドを入力する必要がある。build-to-cache.shスクリプトは、この操作を単一コマンドで実行できるようにし、開発ワークフローを効率化する。

**バッチの実行タイミング**：開発者がローカル環境で手動実行する。コードを変更した後、その変更を他のプロジェクトでテストしたい場合に使用する。

**主要な処理内容**：
1. dotnet runでNukeビルドプロジェクト（_build.csproj）を実行
2. BuildToNuGetCacheターゲットを指定
3. 不要なターゲット（CompileHtmlPreviewer、Compile、Clean）をスキップ

**前後の処理との関連**：直接の依存関係はないが、事前にソースコードの変更が行われていることを想定。後続の処理として、開発者が別のプロジェクトでローカルビルドしたAvaloniaを参照する。

**影響範囲**：ローカルNuGetグローバルキャッシュ（~/.nuget/packages/）にパッケージが展開される。バージョンは「9999.0.0-localbuild」。

## バッチ種別

開発ユーティリティ / シェルスクリプト

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Linux/macOS環境 | シェルスクリプトが実行可能な環境 |
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| カレントディレクトリ | nukebuildディレクトリで実行すること |

### 実行可否判定

特に条件なし。Linux/macOS環境で実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | パラメータなし（固定コマンド） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| nukebuild/_build.csproj | MSBuildプロジェクト | Nukeビルドプロジェクト |
| ソースコード全体 | C#/XAML等 | ビルド対象のソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ~/.nuget/packages/{packageId}/9999.0.0-localbuild | 展開済みパッケージ | NuGetグローバルキャッシュ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | パッケージ内容（DLL、XML等） |
| 出力先 | ~/.nuget/packages/{packageId}/9999.0.0-localbuild |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. dotnet runコマンドの実行
   └─ プロジェクト: _build.csproj
   └─ ターゲット: BuildToNuGetCache
   └─ スキップ: CompileHtmlPreviewer, Compile, Clean
2. Nukeビルドシステムの処理
   └─ CreateNugetPackages（依存関係として自動実行）
   └─ BuildToNuGetCache
3. NuGetキャッシュへのパッケージ展開
```

### フローチャート

```mermaid
flowchart TD
    A[build-to-cache.sh実行] --> B[dotnet run --project _build.csproj]
    B --> C[--target BuildToNuGetCache]
    C --> D[--skip CompileHtmlPreviewer Compile Clean]
    D --> E[Nukeビルドシステム起動]
    E --> F[CreateNugetPackages実行]
    F --> G[BuildToNuGetCache実行]
    G --> H[NuGetキャッシュに展開]
    H --> I[完了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイルエラー | ソースコードにエラーがある | ソースコードの修正 |
| - | dotnet未インストール | .NET SDKがインストールされていない | .NET SDKのインストール |
| - | 権限エラー | スクリプトに実行権限がない | chmod +x build-to-cache.sh |

### リトライ仕様

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

### 障害時対応

エラーメッセージを確認し、原因を特定して対処する。コンパイルエラーの場合は、該当するソースコードを修正して再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 数分（環境依存） |
| メモリ使用量上限 | ローカルマシンの利用可能メモリに依存 |

## 排他制御

同時に複数のbuild-to-cache.sh実行は非推奨。ビルドプロセスが競合する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド開始時 | Nukeの標準出力 |
| 進捗ログ | 各ターゲット実行時 | ターゲット名、処理状況 |
| 終了ログ | 完了時 | 成功/失敗ステータス |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

## 備考

- スクリプトの内容:
  ```sh
  #!/bin/sh
  dotnet run --project _build.csproj -- --target BuildToNuGetCache --skip CompileHtmlPreviewer Compile Clean
  ```
- スキップオプションの意図：
  - CompileHtmlPreviewer: HTMLプレビュー関連のビルドをスキップ（不要な場合）
  - Compile: 通常のコンパイルをスキップ（CreateNugetPackagesで行われる）
  - Clean: クリーンアップをスキップ（インクリメンタルビルドのため）
- nukebuildディレクトリ内で実行する必要がある
- バージョンは「9999.0.0-localbuild」に固定される
- 他のプロジェクトでテストする際は、このバージョンを参照する
