# バッチ設計書 12-ci_post_xcodebuild

## 概要

本ドキュメントは、Xcode Cloud環境でのビルド後処理を実行するシェルスクリプト「ci_post_xcodebuild」のバッチ設計書です。

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

このバッチはXcode Cloudの継続的インテグレーション（CI）環境において、Xcodeビルドが完了した後に必要な後処理を自動的に実行します。特にNightly Buildワークフローにおいて、ビルド成功時にGitタグを付与してリリース管理を支援する重要な役割を担っています。

**業務上の目的・背景**：Wikipedia iOSアプリの開発では、毎日のNightly Buildを通じてベータ版の配布とテストを行っています。ビルドが成功した場合、そのコミットに対してビルド番号をタグ付けすることで、どのバージョンがいつビルドされたかを追跡可能にし、問題発生時の原因特定や、特定バージョンへのロールバックを容易にします。このバッチは、この重要なタグ付け処理を自動化し、人的ミスを防ぎつつリリース管理の効率化を実現しています。

**バッチの実行タイミング**：Xcode Cloudワークフロー実行時、xcodebuildコマンド完了後に自動的にトリガーされます。

**主要な処理内容**：
1. CI_WORKFLOWが「Nightly Build」であるかを判定
2. Nightly Buildの場合、tag_script_xcodebuild.shを実行してGitタグを付与
3. その他のワークフローの場合、タグ付けをスキップ

**前後の処理との関連**：このバッチはXcode Cloudのビルドライフサイクルにおいて最後に実行されるスクリプトです。ci_pre_xcodebuild.shの実行後、Xcodeによるビルド処理が完了した後に呼び出されます。タグ付けが成功すると、GitHubリポジトリにタグがプッシュされます。

**影響範囲**：GitHubリポジトリのタグ（betas/[BUILD_NUMBER]形式）に影響します。

## バッチ種別

ビルドスクリプト / CI後処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（Xcode Cloud ワークフロー完了時） |
| 実行時刻 | 不定（CI トリガー時） |
| 実行曜日 | 不定 |
| 実行日 | 不定 |
| トリガー | Xcode Cloud ワークフロー完了イベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Xcode Cloud環境 | Xcode Cloud CI環境で実行されること |
| CI_WORKFLOW環境変数 | Xcode Cloudにより設定される環境変数が利用可能であること |
| tag_script_xcodebuild.sh | 同一ディレクトリにタグ付けスクリプトが存在すること |

### 実行可否判定

- CI_WORKFLOW が "Nightly Build" の場合：tag_script_xcodebuild.sh を実行
- その他のワークフローの場合：処理をスキップ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| CI_WORKFLOW | 環境変数 | No | なし | Xcode Cloudが設定するワークフロー名 |
| CI_XCODEBUILD_EXIT_CODE | 環境変数 | No | なし | ビルドの終了コード（tag_scriptで使用） |
| CI_APP_STORE_SIGNED_APP_PATH | 環境変数 | No | なし | 署名済みアプリのパス（tag_scriptで使用） |
| CI_BUILD_NUMBER | 環境変数 | No | なし | ビルド番号（tag_scriptで使用） |
| GITHUB_USERNAME | 環境変数 | Yes | なし | GitHubユーザー名（tag_scriptで使用） |
| GITHUB_PAT | 環境変数 | Yes | なし | GitHub Personal Access Token（tag_scriptで使用） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 環境変数 | シェル環境変数 | Xcode Cloudが自動設定するCI環境変数 |
| 環境変数 | シェル環境変数 | Xcode Cloudシークレットとして設定されたGitHub認証情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHubリポジトリ | Gitタグ | betas/[BUILD_NUMBER]形式のタグ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | なし（Gitタグ） |
| 出力先 | GitHubリポジトリ |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. スクリプト開始
   └─ set -e でエラー時停止を設定
2. ワークフロー判定
   └─ CI_WORKFLOW が "Nightly Build" かを確認
3. 条件分岐処理
   └─ Nightly Build の場合: tag_script_xcodebuild.sh を実行
   └─ その他の場合: "Do not execute tag script." を出力
4. スクリプト終了
   └─ exit 0 で正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[set -e でエラー時停止設定]
    B --> C{CI_WORKFLOW == Nightly Build?}
    C -->|Yes| D[tag_script_xcodebuild.sh 実行]
    C -->|No| E[Do not execute tag script 出力]
    D --> F[Execute tag script 出力]
    F --> G[正常終了 exit 0]
    E --> G
```

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

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

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

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

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | スクリプトエラー | tag_script_xcodebuild.sh失敗 | タグスクリプトのエラーログを確認 |
| 1 | 認証エラー | GITHUB_PAT無効 | Personal Access Tokenを再生成 |

### リトライ仕様

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

### 障害時対応

`set -e` によりエラー発生時は即座にスクリプトが停止します。Xcode Cloudのビルドログを確認し、失敗したコマンドを特定してください。タグ付けに失敗した場合は、手動でタグを付与することも可能です。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同一ワークフロー内で1回のみ実行されるため、排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | タグ実行時 | "Execute tag script." |
| 進捗ログ | スキップ時 | "Do not execute tag script." |
| 成功ログ | タグ成功時 | "Successfully tagged betas/[BUILD_NUMBER]" |
| 失敗ログ | タグ失敗時 | "Failure adding tag." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルドワークフロー失敗 | 1回 | Xcode Cloud通知設定による |
| タグ付け失敗 | 1回 | Xcode Cloud通知設定による |

## 備考

- 本スクリプトはXcode Cloudの `ci_scripts` ディレクトリに配置される必要があります
- Xcode Cloudは `ci_post_xcodebuild.sh` という命名規則に従ってスクリプトを自動検出・実行します
- タグ形式は `betas/[CI_BUILD_NUMBER]` です
- GitHub認証情報はXcode Cloudのシークレット設定で管理されています
- ビルドが失敗した場合（CI_XCODEBUILD_EXIT_CODE != 0）や署名パスが空の場合はタグ付けされません
