# バッチ設計書 22-Package

## 概要

本ドキュメントは、Avalonia UIフレームワークのNukeビルドシステムにおける「Package」ターゲットの設計を記述したものである。このターゲットは、テスト実行とNuGetパッケージ作成を包括的に行う統合ターゲットである。

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

Packageターゲットは、Avalonia UIフレームワークのリリース準備として、すべてのテストを実行し、NuGetパッケージを作成し、API差分検証を行う統合ターゲットである。

**業務上の目的・背景**：Avalonia UIフレームワークをNuGetパッケージとして配布するためには、品質保証（テスト実行）、パッケージ作成、API互換性検証を一貫して行う必要がある。Packageターゲットはこれらの工程を統合し、リリース可能な状態のパッケージを確実に作成するための中核的なターゲットである。

**バッチの実行タイミング**：CI/CDパイプライン実行時（特にmacOSおよびWindows環境）、リリースブランチでのビルド時、または開発者がローカル環境でパッケージ作成を行う際に呼び出される。Windowsプラットフォームではデフォルトターゲットとして設定されている。

**主要な処理内容**：
1. RunTestsターゲットの実行（全テストスイート）
2. CreateNugetPackagesターゲットの実行（NuGetパッケージ作成）
3. ValidateApiDiffターゲットの実行（API互換性検証）

**前後の処理との関連**：Compileターゲット、各テストターゲット、CreateIntermediateNugetPackagesターゲットに間接的に依存する。CiAzureOSX、CiAzureWindowsターゲットから呼び出される。

**影響範囲**：artifacts/nugetディレクトリにNuGetパッケージが出力され、API差分検証結果がartifacts/api-diffに出力される。

## バッチ種別

パッケージ作成 / 統合ビルド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CI/CD実行時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | CI/CDパイプライン / 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| .NET SDK | 適切なバージョンの.NET SDKがインストールされていること |
| ソースコード | リポジトリのクローンが完了していること |
| 依存ツール | NuGet、ILRepack等の依存ツールが利用可能であること |

### 実行可否判定

Windowsプラットフォームではデフォルトターゲットとして自動選択される。他のプラットフォームでは明示的な指定が必要。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| configuration | string | No | Release | ビルド構成 |
| skip-tests | bool | No | false | trueの場合、テストをスキップする |
| force-nuget-version | string | No | SharedVersion.propsの値 | 強制的に指定するバージョン |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| dirs.proj | MSBuild | ソリューション定義 |
| build/SharedVersion.props | XML | バージョン定義 |
| nukebuild/numerge.json | JSON | パッケージマージ設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| artifacts/nuget | .nupkg/.snupkg | NuGetパッケージ |
| artifacts/test-results | TRX | テスト結果 |
| artifacts/api-diff | テキスト | API差分検証結果 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | Avalonia.{version}.nupkg等 |
| 出力先 | artifacts/nuget |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. RunTestsの実行
   └─ 全テストスイート（Core、Render、Tools、Previewer、Leak）を実行
2. CreateNugetPackagesの実行
   └─ 中間パッケージ作成、BuildTasksパッチ、パッケージマージ、リファレンスアセンブリ生成
3. ValidateApiDiffの実行
   └─ ベースラインパッケージダウンロード、API互換性検証
```

### フローチャート

```mermaid
flowchart TD
    A[Package開始] --> B[RunTests]
    B --> C[CreateNugetPackages]
    C --> D[CreateIntermediateNugetPackages]
    D --> E[BuildTasksパッチ適用]
    E --> F[パッケージマージ]
    F --> G[リファレンスアセンブリ生成]
    G --> H[ValidateApiDiff]
    H --> I[ベースラインパッケージダウンロード]
    I --> J[API差分検証]
    J --> K[Package完了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | テスト失敗 | テストケースがアサーションに失敗 | テストコードまたは対象コードの修正 |
| - | パッケージマージ失敗 | numerge設定エラー | numerge.jsonの確認 |
| - | API互換性エラー | 破壊的変更の検出 | APIの修正またはsuppressionファイルの更新 |

### リトライ仕様

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

### 障害時対応

失敗時はCIパイプラインが失敗となる。エラーメッセージを確認し、該当する問題を修正後、再度パイプラインを実行する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 複数のNuGetパッケージ |
| 目標処理時間 | プラットフォーム依存（数十分） |
| メモリ使用量上限 | ビルドマシンの利用可能メモリに依存 |

## 排他制御

同一ビルドディレクトリでの同時実行は不可。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド初期化時 | バージョン情報、構成情報 |
| 進捗ログ | 各ターゲット実行時 | ターゲット名、処理状況 |
| 終了ログ | 完了時 | 成功/失敗ステータス |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルド失敗 | 発生時 | Azure Pipelines |
| 処理時間 | タイムアウト値 | Azure Pipelines |

## 備考

- PackageターゲットはWindowsでのデフォルトターゲットとして設定されている（Build.cs Main関数）
- API差分検証はリリースブランチで特に重要であり、破壊的変更がないことを確認する
- リファレンスアセンブリはRefAssemblyGenerator.GenerateRefAsmsInPackageで生成される
