# バッチ設計書 10-.github/workflows/stale.yml

## 概要

本ドキュメントは、GitHub ActionsのStale PR管理ワークフロー設定ファイル `.github/workflows/stale.yml` の設計仕様を定義するものである。

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

このバッチは、GitHub Actionsを使用して長期間非アクティブなプルリクエストを自動的に管理するワークフローである。365日間非アクティブなPRに「stale」ラベルを付与し、さらに30日間アクティビティがない場合は自動的にクローズする。

**業務上の目的・背景**：オープンソースプロジェクトでは、多数のプルリクエストが作成されるが、その一部は長期間放置されることがある。放置されたPRは、メンテナンスの負担となり、リポジトリの状態を把握しにくくする。このワークフローにより、長期間非アクティブなPRを自動的に識別・管理し、プロジェクトの健全な状態を維持する。

**バッチの実行タイミング**：
- 毎日深夜0時（UTC）にスケジュール実行

**主要な処理内容**：
1. 365日間非アクティブなPRを検出
2. 検出したPRに「stale」ラベルを付与
3. staleメッセージをコメントとして投稿
4. さらに30日間非アクティブな場合、PRをクローズ
5. クローズ時にクローズメッセージを投稿

**前後の処理との関連**：このワークフローは独立して動作し、他のワークフローとの直接的な依存関係はない。ただし、特定のラベル（ARC, bounty, Codegen等）が付与されているPRは対象外となる。

**影響範囲**：長期間非アクティブなPRのステータスが変更される。コントリビューターには通知が送信され、対応を促される。

## バッチ種別

自動管理・メンテナンス

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | 0:00 (UTC) |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | cron スケジュール |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actions | リポジトリでGitHub Actionsが有効化されていること |
| actions/stale | actions/stale@v9 アクションが利用可能であること |
| ランナー | GitHub提供のホステッドランナー（ubuntu-latest） |

### 実行可否判定

- cronスケジュールにより自動的に実行される
- 手動でのワークフロー実行も可能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| days-before-pr-stale | 数値 | Yes | 365 | PRがstaleになるまでの日数 |
| days-before-pr-close | 数値 | Yes | 30 | staleからクローズまでの日数 |
| days-before-issue-stale | 数値 | Yes | -1 | Issueのstale処理（無効） |
| days-before-issue-close | 数値 | Yes | -1 | Issueのクローズ処理（無効） |
| exempt-pr-labels | 文字列 | Yes | - | 対象外PRラベル |
| exempt-issue-labels | 文字列 | Yes | - | 対象外Issueラベル |
| stale-pr-message | 文字列 | Yes | - | stale時のメッセージ |
| close-pr-message | 文字列 | Yes | - | クローズ時のメッセージ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| GitHub API | REST API | リポジトリのPR/Issue情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| PRラベル | GitHub Label | 「stale」ラベルの付与 |
| PRコメント | Markdown | stale/クローズ通知 |
| PRステータス | GitHub PR Status | クローズ処理 |

### 出力ファイル仕様

該当なし（GitHub APIを通じて直接操作）

## 処理フロー

### 処理シーケンス

```
1. スケジュール実行
   └─ 毎日0:00 (UTC)
2. PR検索
   └─ 365日以上非アクティブなPRを検出
3. 除外ラベル確認
   └─ exempt-pr-labelsに該当するPRを除外
4. staleラベル付与
   └─ 条件を満たすPRにstaleラベルを付与
5. staleメッセージ投稿
   └─ PRにコメントを投稿
6. クローズ処理
   └─ staleから30日経過したPRをクローズ
7. クローズメッセージ投稿
   └─ クローズされたPRにコメントを投稿
```

### フローチャート

```mermaid
flowchart TD
    A[スケジュール実行 0:00 UTC] --> B[PR検索]
    B --> C{365日以上非アクティブ?}
    C -->|No| D[スキップ]
    C -->|Yes| E{除外ラベルあり?}
    E -->|Yes| D
    E -->|No| F{既にstale?}
    F -->|No| G[staleラベル付与]
    G --> H[staleメッセージ投稿]
    F -->|Yes| I{staleから30日経過?}
    I -->|No| D
    I -->|Yes| J[PRクローズ]
    J --> K[クローズメッセージ投稿]
    H --> L[終了]
    K --> L
    D --> L
```

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

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

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | API制限エラー | GitHub APIレート制限到達 | 次回実行まで待機 |
| - | 権限エラー | トークン権限不足 | ワークフロー設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | actions/stale内部で処理 |
| リトライ間隔 | N/A |
| リトライ対象エラー | 一時的なAPIエラー |

### 障害時対応

1. GitHub Actionsのログを確認
2. APIレート制限に達していないか確認
3. 必要に応じて手動でワークフローを再実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リポジトリのオープンPR数に依存 |
| 目標処理時間 | 制限なし |
| メモリ使用量上限 | GitHub提供のホステッドランナー依存 |

## 排他制御

- 日次で1回のみ実行されるため、並行実行は発生しない
- 手動実行した場合のみ並行実行の可能性あり

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 処理ログ | 各PR処理時 | stale/クローズ対象のPR情報 |
| エラーログ | エラー発生時 | 失敗原因の詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー実行状態 | - | GitHub Actionsステータス |
| stale化PR数 | - | 実行ログ |

## 備考

### 除外ラベル

以下のラベルが付与されているPRは、stale処理の対象外となる：

| ラベル | 説明 |
|--------|------|
| ARC | ARC関連の作業 |
| bounty | バウンティ対象 |
| Codegen | コード生成関連 |
| Crash | クラッシュ関連 |
| Generics | ジェネリクス関連 |
| High Priority | 高優先度 |
| Macros | マクロ関連 |
| Next release | 次回リリース対象 |
| Showstopper | 重大な問題 |
| Static[T] | Static型関連 |

Issueに対しても以下のラベルが除外対象：
- Showstopper
- Severe
- bounty
- Compiler Crash
- Medium Priority

### メッセージ

**stale時のメッセージ：**
> This pull request is stale because it has been open for 1 year with no activity.
> Contribute more commits on the pull request and rebase it on the latest devel,
> or it will be closed in 30 days. Thank you for your contributions.

**クローズ時のメッセージ：**
> This pull request has been marked as stale and closed due to inactivity after 395 days.

### 設定値

| 設定 | 値 | 説明 |
|------|-----|------|
| days-before-pr-stale | 365 | 1年間非アクティブでstale |
| days-before-pr-close | 30 | staleから30日でクローズ |
| days-before-issue-stale | -1 | Issueはstale処理しない |
| days-before-issue-close | -1 | Issueはクローズしない |

### 注意事項

- Issueに対してはstale処理を行わない（`days-before-issue-stale: -1`）
- PRのみが対象となっている
- 合計395日（365日 + 30日）経過するとPRがクローズされる
