# バッチ設計書 7-.github/workflows/ci_packages.yml

## 概要

本ドキュメントは、GitHub ActionsのパッケージテストCI設定ファイル `.github/workflows/ci_packages.yml` の設計仕様を定義するものである。

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

このバッチは、GitHub Actionsを使用してNimbleパッケージとの互換性テストを自動的に実行するCI/CDワークフローである。testamentテストフレームワークを使用し、バッチ分割テスト方式で複数のテストを並列実行することで、Nimコンパイラの変更がサードパーティパッケージに与える影響を検証する。

**業務上の目的・背景**：Nimコンパイラの変更は、Nimbleエコシステムの多数のパッケージに影響を与える可能性がある。コンパイラの変更によってサードパーティパッケージが壊れないことを確認するため、主要なパッケージとの互換性テストを継続的に実行する必要がある。このワークフローは、複数のプラットフォームで並列にテストを実行し、互換性問題を早期に発見することを目的としている。

**バッチの実行タイミング**：
- `devel` ブランチへのプッシュ時
- `version-2-2`、`version-2-0`、`version-1-6`、`version-1-2` ブランチへのプッシュ時
- 全てのプルリクエスト時

**主要な処理内容**：
1. リポジトリのチェックアウト
2. Node.js 20.x のインストール
3. プラットフォーム固有の依存関係インストール
4. csourcesからのNimコンパイラビルド
5. kochビルドとrunCI実行（testamentによるパッケージテスト）

**前後の処理との関連**：このワークフローは `ci/funs.sh` のユーティリティ関数に依存している。`NIM_TEST_PACKAGES=1` 環境変数により、パッケージテストモードが有効化される。`NIM_TESTAMENT_BATCH` 環境変数により、テストがバッチ分割される。

**影響範囲**：テスト結果はGitHub Actionsのダッシュボードで確認可能。テスト失敗は、Nimコンパイラの変更がサードパーティパッケージとの互換性に問題を起こす可能性を示す。

## バッチ種別

CI/CD（パッケージ互換性テスト）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | コード変更時（プッシュ/PR時） |
| 実行時刻 | コード変更タイミング |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Git push / Pull Request |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actions | リポジトリでGitHub Actionsが有効化されていること |
| ランナー | GitHub提供のホステッドランナー（ubuntu-latest, macos-14） |
| Node.js | Node.js 20.x が使用可能であること |

### 実行可否判定

- 指定されたブランチへのプッシュまたはPR時に実行
- `concurrency` 設定により、同一PR/ブランチの同時実行は制御される

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| os | マトリクス | Yes | - | ランナーのOSイメージ |
| batch | マトリクス | Yes | - | テストバッチ識別子 |
| cpu | マトリクス | Yes | - | CPUアーキテクチャ |
| NIM_TEST_PACKAGES | 環境変数 | Yes | "1" | パッケージテストモード有効化 |
| NIM_TESTAMENT_BATCH | 環境変数 | Yes | matrix.batch | テストバッチ番号 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/build_config.txt | テキスト | csourcesのバージョン情報 |
| ci/funs.sh | シェルスクリプト | ユーティリティ関数 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHub Actions | Webダッシュボード | ビルド/テスト結果 |
| ログ出力 | テキスト | 各ステップの実行ログ |

### 出力ファイル仕様

該当なし（CI結果はGitHub Actionsに出力）

## 処理フロー

### 処理シーケンス

```
1. リポジトリチェックアウト
   └─ fetchDepth: 2
2. Node.jsインストール
   └─ Node.js 20.x
3. 依存関係インストール
   └─ Linux: apt-get install（libcurl, libgc, libsdl等）
   └─ macOS: brew install（boehmgc, make, sfml, gtk+3）
4. PATH設定
   └─ bin/ をPATHに追加
5. システム情報出力
   └─ nimCiSystemInfo
6. csourcesビルド
   └─ nimBuildCsourcesIfNeeded
7. kochビルドとCI実行
   └─ nimInternalBuildKochAndRunCI
   └─ NIM_TEST_PACKAGES=1, NIM_TESTAMENT_BATCH で制御
```

### フローチャート

```mermaid
flowchart TD
    A[ワークフロー開始] --> B[リポジトリチェックアウト]
    B --> C[Node.js 20.xインストール]
    C --> D{Linux amd64?}
    D -->|Yes| E[Linux依存関係インストール]
    D -->|No| F{macOS?}
    F -->|Yes| G[macOS依存関係インストール]
    E --> H[PATH設定]
    G --> H
    F -->|No| H
    H --> I[システム情報出力]
    I --> J[csourcesビルド]
    J --> K[koch, runCI実行]
    K --> L[ワークフロー終了]
```

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

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

該当なし（このバッチはデータベースを使用しない）

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ビルドエラー | コンパイル失敗 | ログを確認して修正 |
| 1 | テストエラー | パッケージテスト失敗 | 失敗したテストを確認 |
| 1 | 依存関係エラー | パッケージインストール失敗 | CIを再実行 |
| タイムアウト | タイムアウト | 60分を超過 | 処理の最適化が必要 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | GitHub Actions設定に依存 |
| リトライ間隔 | 手動での再実行 |
| リトライ対象エラー | 一時的なネットワークエラー等 |

### 障害時対応

1. GitHub Actionsのログを確認
2. 失敗したバッチとテストを特定
3. `allowed_failures` バッチで失敗した場合は許容される場合あり
4. 必要に応じてローカルで再現テスト

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベース不使用） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8ジョブ（2 OS x 4 バッチ） |
| 目標処理時間 | 60分以内（タイムアウト設定） |
| メモリ使用量上限 | GitHub提供のホステッドランナー依存 |

## 排他制御

- `concurrency` 設定により同一グループのワークフローが制御される
- `cancel-in-progress: true` により、同一PR/ブランチで新しいワークフローが開始されると進行中のものはキャンセル
- グループキー: `${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}`

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| システム情報 | ワークフロー開始時 | nimCiSystemInfo |
| コマンドログ | 各ステップ実行時 | 実行コマンドと結果 |
| テスト結果 | testament実行時 | パッケージテスト結果 |
| エラーログ | エラー発生時 | 失敗原因の詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ実行時間 | 60分 | GitHub Actionsタイムアウト |
| ビルド成功率 | - | GitHub Actionsステータス |

## 備考

### マトリクス構成

| os | cpu | batch | 説明 |
|-----|-----|-------|------|
| ubuntu-latest | amd64 | allowed_failures | 失敗許容テスト |
| ubuntu-latest | amd64 | 0_3 | テストバッチ0（全3分割） |
| ubuntu-latest | amd64 | 1_3 | テストバッチ1（全3分割） |
| ubuntu-latest | amd64 | 2_3 | テストバッチ2（全3分割） |
| macos-14 | arm64 | allowed_failures | 失敗許容テスト |
| macos-14 | arm64 | 0_3 | テストバッチ0（全3分割） |
| macos-14 | arm64 | 1_3 | テストバッチ1（全3分割） |
| macos-14 | arm64 | 2_3 | テストバッチ2（全3分割） |

### トリガー対象ブランチ

| ブランチ | 説明 |
|---------|------|
| devel | 開発版 |
| version-2-2 | Nim 2.2.x系 |
| version-2-0 | Nim 2.0.x系 |
| version-1-6 | Nim 1.6.x系 |
| version-1-2 | Nim 1.2.x系 |

### 依存関係一覧

| プラットフォーム | インストールパッケージ |
|-----------------|----------------------|
| Linux amd64 | libcurl4-openssl-dev, libgc-dev, libsdl1.2-dev, libsfml-dev, valgrind, libc6-dbg, libblas-dev, liblapack-dev, libpcre3, xorg-dev |
| macOS | boehmgc, make, sfml, gtk+3 |

### 環境変数

| 変数名 | 値 | 説明 |
|--------|-----|------|
| NIM_TEST_PACKAGES | "1" | パッケージテストモードを有効化 |
| NIM_TESTAMENT_BATCH | matrix.batch | testamentのバッチ分割指定 |

### バッチ分割について

testamentは `NIM_TESTAMENT_BATCH` 環境変数により、テストを複数のバッチに分割して実行できる。これにより、大量のテストを複数のジョブで並列実行し、CI全体の実行時間を短縮する。

- `allowed_failures`: 失敗が許容されるテスト（不安定なテストや既知の問題があるテスト）
- `0_3`, `1_3`, `2_3`: テストを3分割した際の各バッチ（0番目、1番目、2番目）
