# バッチ設計書 26-BuildToNuGetCache

## 概要

本ドキュメントは、Avalonia UIフレームワークのNukeビルドシステムにおける「BuildToNuGetCache」ターゲットの設計を記述したものである。このターゲットは、ローカル開発環境でビルドしたNuGetパッケージをローカルキャッシュにインストールするための開発者向けユーティリティである。

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

BuildToNuGetCacheターゲットは、Avaloniaをローカルでビルドし、生成されたNuGetパッケージをローカルのNuGetグローバルキャッシュに直接インストールするターゲットである。これにより、開発者は修正したAvaloniaを即座に他のプロジェクトでテストできる。

**業務上の目的・背景**：Avalonia UIフレームワークの開発者が、ローカルで行った変更を別のプロジェクトでテストする際、通常はNuGetパッケージを公開するか、ローカルNuGetフィードを設定する必要がある。BuildToNuGetCacheターゲットは、この手順を簡略化し、ビルド済みパッケージを直接グローバルキャッシュに展開することで、開発効率を大幅に向上させる。

**バッチの実行タイミング**：開発者がローカル環境で手動実行する。CI/CD環境では使用しない。

**主要な処理内容**：
1. CreateNugetPackagesターゲットの実行（NuGetパッケージ作成）
2. 生成されたnupkgファイルをスキャン
3. 各パッケージをNuGetグローバルキャッシュに展開
4. パッケージメタデータファイル（.nupkg.metadata）を生成

**前後の処理との関連**：CreateNugetPackagesターゲットに依存する。後続の処理はなく、開発者が別途他のプロジェクトで参照することを想定。

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

## バッチ種別

開発ユーティリティ / パッケージインストール

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ローカルビルド環境 | IsPackingToLocalCache = true であること |
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| NuGetグローバルキャッシュ | 書き込み可能であること |

### 実行可否判定

BuildToNuGetCacheがスケジュールターゲットに含まれている場合、自動的にIsPackingToLocalCacheフラグがtrueに設定される。このフラグがfalseの場合、InvalidOperationExceptionがスローされる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| configuration | string | No | Release | ビルド構成 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| artifacts/nuget/*.nupkg | NuGetパッケージ | 生成されたNuGetパッケージ |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. CreateNugetPackagesの実行
   └─ NuGetパッケージを作成
2. NuGetグローバルキャッシュパスの取得
   └─ SettingsUtility.GetGlobalPackagesFolder()
3. 各nupkgファイルについてループ
   └─ ZIPとして開く
   └─ nuspecファイルからパッケージIDを抽出
   └─ 既存のキャッシュディレクトリを削除
   └─ 新しいディレクトリを作成
   └─ ZIPを展開
   └─ .nupkg.metadataファイルを生成
```

### フローチャート

```mermaid
flowchart TD
    A[BuildToNuGetCache開始] --> B[CreateNugetPackages]
    B --> C[グローバルキャッシュパス取得]
    C --> D[nupkgファイル一覧取得]
    D --> E{nupkgあり?}
    E -->|Yes| F[nupkgをZIPとして開く]
    F --> G[nuspecからパッケージID抽出]
    G --> H[既存キャッシュ削除]
    H --> I[新規ディレクトリ作成]
    I --> J[ZIP展開]
    J --> K[.nupkg.metadata生成]
    K --> E
    E -->|No| L[BuildToNuGetCache完了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| InvalidOperationException | 実行条件エラー | IsPackingToLocalCacheがfalse | BuildToNuGetCacheターゲットを明示的に指定 |
| - | ファイルアクセスエラー | キャッシュディレクトリに書き込み不可 | 権限の確認 |
| - | ZIPエラー | nupkgファイルが破損 | パッケージの再作成 |

### リトライ仕様

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

### 障害時対応

エラー発生時は、エラーメッセージを確認し、原因を特定して対処する。キャッシュディレクトリの削除に失敗した場合は、手動で削除後に再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | パッケージ単位 |
| コミットタイミング | 各パッケージ展開完了時 |
| ロールバック条件 | なし（中断時は部分的に展開される可能性あり） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十のNuGetパッケージ |
| 目標処理時間 | 数分 |
| メモリ使用量上限 | ローカルマシンの利用可能メモリに依存 |

## 排他制御

同時に複数のBuildToNuGetCache実行は非推奨。同一パッケージの書き込み競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド初期化時 | バージョン情報（9999.0.0-localbuild） |
| 進捗ログ | 各パッケージ処理時 | パッケージ名、展開先 |
| 終了ログ | 完了時 | 成功ステータス |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

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

## 備考

- バージョンは常に「9999.0.0-localbuild」が使用される（LocalBuildVersion定数）
- IsPackingToLocalCacheがtrueの場合、以下のオプションが有効になる：
  - ForcePackAvaloniaNative: True
  - SkipObscurePlatforms: True
  - SkipBuildingSamples: True
  - SkipBuildingTests: True
- .nupkg.metadataファイルにはダミーのcontentHashが設定される
- 使用する際は、他のプロジェクトでバージョン「9999.0.0-localbuild」を参照する必要がある
- build-to-cache.shスクリプトで簡易実行可能
