# バッチ設計書 9-OutputVersion

## 概要

本ドキュメントは、Avaloniaプロジェクトにおける Nukeビルドターゲット `OutputVersion` のバッチ設計書です。

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

このNukeビルドターゲットは、現在のビルドバージョンとプルリクエスト番号をファイルに出力するためのCI/CD用ターゲットです。Azure Pipelinesなどのビルドシステムが、ビルドバージョン情報を後続のステップで参照できるようにします。

**業務上の目的・背景**：CI/CDパイプラインでは、ビルドされたアーティファクトにバージョン番号を付与したり、プルリクエストに関連付けたりする必要があります。このターゲットは、Nukeビルドシステムで計算されたバージョン番号とプルリクエスト情報をテキストファイルに出力することで、パイプラインの他のステップ（リリース作成、通知など）がこれらの情報にアクセスできるようにします。

**バッチの実行タイミング**：CI/CDパイプライン（主にAzure Pipelines）で、バージョン情報が必要なタイミングで実行されます。`--version-output-dir`パラメータの指定が必須です。

**主要な処理内容**：
1. 指定されたディレクトリにversion.txtファイルを作成し、現在のビルドバージョンを出力
2. 同ディレクトリにprId.txtファイルを作成し、プルリクエスト番号を出力
3. コンソールにもバージョン情報を出力

**前後の処理との関連**：このターゲットは独立しており、他のターゲットへの依存関係はありません。CI/CDパイプラインの初期段階で実行され、出力されたファイルは後続のステップで参照されます。

**影響範囲**：指定されたVersionOutputDirにversion.txtとprId.txtファイルが作成されます。

## バッチ種別

ビルドターゲット / CI/CD支援

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | CI/CDパイプライン実行時 |
| 実行時刻 | パイプラインの実行タイミング |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| VersionOutputDir | --version-output-dirパラメータが指定されていること |
| 書き込み権限 | 出力ディレクトリへの書き込み権限 |

### 実行可否判定

- `Requires(() => VersionOutputDir)` により、VersionOutputDirパラメータが必須

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| version-output-dir | AbsolutePath | Yes | - | バージョンファイルの出力先ディレクトリ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| BuildParameters.Version | string | 計算されたビルドバージョン |
| SYSTEM_PULLREQUEST_PULLREQUESTNUMBER | 環境変数 | Azure PipelinesのPR番号 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| {VersionOutputDir}/version.txt | テキスト | ビルドバージョン |
| {VersionOutputDir}/prId.txt | テキスト | プルリクエスト番号 |
| コンソール | ログ | バージョンとPR番号の情報 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | version.txt, prId.txt |
| 出力先 | --version-output-dirで指定したディレクトリ |
| 文字コード | UTF-8（BOMなし） |
| 形式 | プレーンテキスト（1行） |

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ VersionOutputDirの必須チェック
2. バージョン出力
   └─ version.txtにParameters.Versionを書き込み
   └─ コンソールにバージョンを出力
3. PR番号出力
   └─ 環境変数SYSTEM_PULLREQUEST_PULLREQUESTNUMBERを取得
   └─ prId.txtにPR番号を書き込み
   └─ コンソールにPR番号を出力
```

### フローチャート

```mermaid
flowchart TD
    A[OutputVersionターゲット開始] --> B{VersionOutputDir指定済み?}
    B -->|No| C[エラー: 必須パラメータ未指定]
    B -->|Yes| D[バージョン取得]
    D --> E[version.txtに書き込み]
    E --> F[コンソールにバージョン出力]
    F --> G[PR番号を環境変数から取得]
    G --> H[prId.txtに書き込み]
    H --> I[コンソールにPR番号出力]
    I --> J[ターゲット正常終了]
```

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

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 例外 | パラメータ未指定 | VersionOutputDirが未指定 | --version-output-dirパラメータを指定 |
| 例外 | IO例外 | ファイル書き込み失敗 | ディレクトリの存在と権限を確認 |

### リトライ仕様

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

### 障害時対応

1. VersionOutputDirパラメータが正しく指定されているか確認
2. 出力ディレクトリの存在と書き込み権限を確認
3. 環境変数SYSTEM_PULLREQUEST_PULLREQUESTNUMBERの設定を確認（Azure Pipelines環境）

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 2ファイルの書き込み |
| 目標処理時間 | 1秒未満 |
| メモリ使用量上限 | 最小限 |

## 排他制御

特になし。ファイル書き込みは短時間で完了します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | バージョン出力時 | "Version is: {version}" |
| 情報ログ | PR番号出力時 | "PR Number is: {prId}" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非ゼロ | CI/CDパイプライン通知 |

## 備考

- `Requires(() => VersionOutputDir)` により、--version-output-dirパラメータが必須です
- バージョンはBuildParameters.Versionから取得されます（SharedVersion.propsから読み取り、CI環境ではビルド番号が付加される場合があります）
- PR番号は環境変数 `SYSTEM_PULLREQUEST_PULLREQUESTNUMBER` から取得されます（Azure Pipelines固有）
- PRビルドでない場合、prId.txtは空またはnullの値が書き込まれます
- 出力されたファイルは、Azure Pipelinesの後続タスクでアーティファクトのバージョニングやリリースノート生成に使用できます
