# バッチ設計書 35-CLA.yml

## 概要

本ドキュメントは、Avaloniaプロジェクトへのコントリビューターからのライセンス同意（CLA: Contributor License Agreement）を自動的に管理するGitHub Actions定義ファイル「CLA.yml」の設計仕様を記載するものです。

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

このワークフローは、プルリクエストやIssueコメントの際に自動的にトリガーされ、コントリビューターがContributor License Agreement（CLA）に同意しているかを確認し、未同意の場合は同意を促すCLAボットです。

**業務上の目的・背景**：オープンソースプロジェクトでは、外部コントリビューターからのコード貢献を受け入れる際に、法的なライセンス問題を回避するためCLAへの同意が必要です。Avaloniaプロジェクトでは、すべてのコントリビューターがCLAに同意していることを自動的に検証することで、ライセンスコンプライアンスを維持し、法的リスクを軽減します。手動確認の手間を省き、コントリビューションワークフローの効率化を実現します。

**バッチの実行タイミング**：以下のGitHubイベントでトリガーされます：
- Issue/PRへのコメント作成時（issue_comment: created）
- プルリクエストのオープン時（pull_request_target: opened）
- プルリクエストのクローズ時（pull_request_target: closed）
- プルリクエストの同期時（pull_request_target: synchronize）

**主要な処理内容**：
1. AvaloniaCLABotリポジトリをクローン
2. CLAボットアクションを実行してCLA同意状況を確認・管理

**前後の処理との関連**：PRがマージされる前にCLA同意が確認される必要があります。CLA未同意の場合はPRにコメントで通知され、マージがブロックされる可能性があります。

**影響範囲**：すべてのプルリクエストとコントリビューターに影響します。CLA同意状況はGitHubのPRおよびIssue上で管理・表示されます。

## バッチ種別

CI/CD パイプライン（コンプライアンス管理）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動 |
| 実行時刻 | イベント発生時 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | issue_comment / pull_request_target |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Secrets | CLA_PATシークレットが設定されていること |
| CLABotリポジトリ | AvaloniaUI/AvaloniaCLABotリポジトリがアクセス可能であること |
| PRまたはIssue | プルリクエストに関連するイベントであること |

### 実行可否判定

以下の条件を満たす場合にのみCLAボットが実行されます：
- イベントがプルリクエストに関連している（`github.event.issue.pull_request`）
- コメント作成者がcla-avaloniaでない、またはpull_request_targetイベントである

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| CLA_PAT | secret | Yes | なし | CLABotリポジトリアクセス用Personal Access Token |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| github.event | JSON | GitHubイベントペイロード |
| AvaloniaUI/AvaloniaCLABot | Gitリポジトリ | CLAボットのソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| PRコメント | Markdown | CLA同意状況の通知コメント |
| PRステータス | GitHub Status | CLA確認結果のステータス |

### 出力ファイル仕様

本ワークフローはファイル出力を行いません。GitHubのPR/Issue上でコメントとステータスを更新します。

## 処理フロー

### 処理シーケンス

```
1. ワークフロートリガー
   └─ issue_comment:created または pull_request_target イベント
2. 実行条件チェック
   └─ PRに関連するイベントか確認
   └─ コメント作成者がcla-avaloniaでないか確認
3. CLABotリポジトリクローン
   └─ AvaloniaUI/AvaloniaCLABot をmainブランチからクローン
   └─ CLA_PATを使用した認証
4. CLAボット実行
   └─ ./CLABot アクションを実行
   └─ PERSONAL_ACCESS_TOKEN環境変数を設定
5. CLA確認・通知
   └─ コントリビューターのCLA同意状況を確認
   └─ 必要に応じてPRにコメント追加
```

### フローチャート

```mermaid
flowchart TD
    A[GitHubイベント発生] --> B{PRに関連?}
    B -->|No| C[処理終了]
    B -->|Yes| D{コメント者がcla-avalonia?}
    D -->|Yes かつ issue_comment| C
    D -->|No または pull_request_target| E[CLABotリポジトリクローン]
    E --> F[CLAボットアクション実行]
    F --> G[CLA状況確認]
    G --> H{CLA同意済み?}
    H -->|Yes| I[成功ステータス設定]
    H -->|No| J[同意依頼コメント投稿]
    I --> K[処理終了]
    J --> K
```

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

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

本バッチは外部データベースを直接操作しません。CLA同意情報はAvaloniaCLABotの内部で管理されます。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 認証エラー | CLA_PATが無効または期限切れ | シークレットを更新 |
| - | リポジトリクローン失敗 | CLABotリポジトリにアクセス不可 | PAT権限を確認 |
| - | ボット実行エラー | CLAボットの内部エラー | CLABotリポジトリのログを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | GitHub Actionsのデフォルト設定に依存 |
| リトライ間隔 | - |
| リトライ対象エラー | 一時的なネットワークエラー |

### 障害時対応

ワークフロー失敗時は以下を確認してください：
1. CLA_PATシークレットが有効で適切な権限を持っているか
2. AvaloniaUI/AvaloniaCLABotリポジトリがアクセス可能か
3. GitHub Actionsのログで詳細なエラー内容を確認

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1イベントあたり1回 |
| 目標処理時間 | 1分以内 |
| メモリ使用量上限 | GitHub Actionsの制限に依存 |

## 排他制御

同一PRに対する複数のイベントが連続して発生した場合、それぞれ独立して実行されます。CLAボット側で同意状況の整合性を管理します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| アクションログ | 各ステップ実行時 | コマンド出力、エラーメッセージ |
| PRコメント | CLA確認時 | CLA同意状況の通知 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー失敗 | 1回 | GitHub通知設定に依存 |

## 備考

- 本ワークフローはGitHub Actionsで実行されます（Azure Pipelinesではありません）
- CLAボットの実装はAvaloniaUI/AvaloniaCLABotリポジトリで管理されています
- cla-avaloniaアカウントはボット専用アカウントであり、ボット自身のコメントには反応しないよう制御されています
- CLA_PATはGitHubのPersonal Access Tokenで、CLABotリポジトリへのアクセスとPRへのコメント投稿権限が必要です
- `pull_request_target`イベントを使用しているため、フォークからのPRでも安全に実行されます
- ワークフロー名は「Avalonia CLA Bot」です
