# バッチ設計書 10-License Compliance

## 概要

本ドキュメントは、License Complianceバッチ（license.yml）の設計仕様を記載したものである。このバッチは、Pull RequestおよびMerge Group時にlicense_finder CLIを使用して依存ライブラリのライセンスコンプライアンスをチェックするCI/CDバッチである。

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

**業務上の目的・背景**：オープンソースプロジェクトでは、使用する依存ライブラリのライセンスが適切であることを確認する必要がある。不適切なライセンス（例：GPL系ライセンスの商用利用制限）を持つライブラリの混入を防ぐため、PRマージ前にライセンスチェックを自動実行する。本バッチは、license_finderを使用して依存関係のライセンスを検証し、ポリシーに違反するライブラリがある場合は警告を出す。

**バッチの実行タイミング**：Pull Request作成/更新時、およびMerge Groupへの追加時に自動実行される。

**主要な処理内容**：
1. 依存関係ファイルの変更有無をキャッシュで確認
2. 変更がある場合のみ、pnpm環境とlicense_finderをセットアップ
3. license_finderを実行してライセンスコンプライアンスを検証
4. ポリシー違反がある場合はエラーで終了

**前後の処理との関連**：License Report Update（license-report-update.yml）で生成されたレポートとの整合性を保つ。本バッチはPRのマージ可否を判定するRequired Checkとして使用可能。

**影響範囲**：PR/Merge Groupのステータス、マージ可否判定

## バッチ種別

CI/CD / ライセンスコンプライアンス検証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | pull_request / merge_group |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js/pnpm | 依存関係解析に必要 |
| Ruby/gem | license_finderのインストールに必要 |
| config/dependency_decisions.yml | ライセンス許可設定ファイル |
| config/license_finder.yml | license_finder設定ファイル |

### 実行可否判定

- pull_requestまたはmerge_groupイベント時に実行
- 以下のファイルに変更がない場合は実質スキップ（キャッシュヒット時）：
  - `.github/workflows/license.yml`
  - `config/dependency_decisions.yml`
  - `config/license_finder.yml`
  - `package.json`
  - `pnpm-lock.yaml`

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | 入力パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| package.json | JSON | 依存関係定義 |
| pnpm-lock.yaml | YAML | ロックファイル |
| config/dependency_decisions.yml | YAML | ライセンス許可設定 |
| config/license_finder.yml | YAML | license_finder設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHub Checks | API | ライセンスチェック結果ステータス |
| GitHub Actions Log | テキスト | 詳細実行ログ |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. コードチェックアウト
   └─ actions/checkout@v4.3.0
   └─ persist-credentials: false
2. 依存関係ファイルキャッシュ確認
   └─ actions/cache@v4.3.0
   └─ 対象ファイルのハッシュで判定
3. 変更有無判定
   └─ キャッシュヒット時: files_changed=false
   └─ キャッシュミス時: files_changed=true
4. pnpm環境セットアップ（変更あり時のみ）
   └─ .github/actions/pnpm-setup
5. license_finderインストール（変更あり時のみ）
   └─ sudo gem install -N license_finder
6. license_finder実行（変更あり時のみ）
   └─ license_finder
   └─ ポリシー違反があればエラー終了
```

### フローチャート

```mermaid
flowchart TD
    A[PR/Merge Groupイベント] --> B[コードチェックアウト]
    B --> C[キャッシュ確認]
    C --> D{キャッシュヒット?}
    D -->|はい| E[files_changed=false]
    D -->|いいえ| F[files_changed=true]
    E --> G[処理スキップ]
    F --> H[pnpm環境セットアップ]
    H --> I[license_finderインストール]
    I --> J[license_finder実行]
    J --> K{ポリシー違反?}
    K -->|あり| L[失敗]
    K -->|なし| M[成功]
    G --> N[バッチ終了]
    L --> N
    M --> N
```

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

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

データベース操作なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ライセンス違反 | 許可されていないライセンスの検出 | dependency_decisions.ymlで許可を追加、または依存関係を削除 |
| - | gem install失敗 | ネットワークエラー/権限不足 | 再実行 |
| - | license_finder失敗 | 依存関係解析エラー | ログ確認、依存関係修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（PRへの再プッシュで再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

- ライセンス違反時：違反ライセンスを確認し、dependency_decisions.ymlで許可を追加するか、依存関係を削除
- license_finder失敗時：ログを確認し、原因を特定して対処

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回/PR更新 |
| 目標処理時間 | 10分以内（timeout-minutes: 10） |
| メモリ使用量上限 | GitHub Actions標準ランナー制限内 |

## 排他制御

- concurrencyグループ: `${{ github.workflow }}-${{ github.ref }}`
- 同時実行時は後続ジョブが待機

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 各ステップ開始時 | ステップ名 |
| 進捗ログ | 処理中 | license_finder出力 |
| 終了ログ | バッチ終了時 | 成功/失敗ステータス |
| エラーログ | エラー発生時 | 違反ライセンス詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 10分 | GitHub Actionsタイムアウト |
| エラー発生 | - | GitHub PR Checks |

## 備考

- キャッシュを使用して不要な実行を回避（mainブランチへのマージ前提条件として常に成功が必要）
- キャッシュ対象ファイル：
  - `.github/workflows/license.yml`
  - `config/dependency_decisions.yml`
  - `config/license_finder.yml`
  - `package.json`
  - `pnpm-lock.yaml`
- キャッシュキー：`license-{os}-{hash(対象ファイル)}`
- license_finderの-Nオプション：ドキュメントのインストールをスキップ（高速化）
- ライセンス許可設定は`config/dependency_decisions.yml`で管理
- license_finder設定は`config/license_finder.yml`で管理
