# バッチ設計書 7-format-suggest

## 概要

本ドキュメントは、GitHub Actionsを使用してairフォーマッターでコードを整形し、Pull Requestに修正提案をコメントするワークフローの設計書である。

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

このバッチは、Pull Request作成・更新時に自動的にトリガーされ、airフォーマッターを使用してRコードのフォーマットチェックを行い、フォーマット違反がある場合はreviewdogを通じてPRに修正提案をコメントする処理を行う。

**業務上の目的・背景**：コードスタイルの一貫性は、チーム開発において重要な要素である。airは高速なRコードフォーマッターであり、コードスタイルを自動的に統一することで、コードレビューの効率化とコードベースの可読性向上に貢献する。reviewdogを使用することで、PRに直接修正提案をコメントでき、コントリビューターが簡単に修正を適用できる。

**バッチの実行タイミング**：Pull Request作成・更新時に自動実行される。pull_request_targetを使用することで、フォークからのPRに対しても書き込み権限を持って実行できる。

**主要な処理内容**：
1. PRのHEAD SHAでリポジトリをチェックアウト
2. airフォーマッターのインストール
3. air formatコマンドでコード整形
4. reviewdogでフォーマット差分をPRにコメント

**前後の処理との関連**：R-CMD-checkやtest-coverageワークフローと並行して実行される。フォーマット提案は情報提供目的であり、マージをブロックしない設定も可能。

**影響範囲**：PRのコメントおよびレビューに影響。コードベース自体は変更されない（提案のみ）。

## バッチ種別

CI/CD（コードフォーマットチェック）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動 |
| 実行時刻 | N/A（イベント発生時） |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | pull_request_target |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actionsの有効化 | リポジトリでGitHub Actionsが有効であること |
| GITHUB_TOKEN | シークレットとしてGITHUB_TOKENが利用可能であること |
| pull-requests: write権限 | PRへのコメント書き込み権限 |

### 実行可否判定

GitHubのpull_request_targetイベントにより自動的に実行判定される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチはGitHubイベントにより自動実行 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| リポジトリコード | Git | PRのHEAD SHAでチェックアウトされたソースコード |
| *.R | Rソース | フォーマット対象のRファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| PRコメント | GitHub Review | フォーマット修正提案 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | N/A（PRコメントのみ） |
| 出力先 | GitHub PR |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. ワークフロートリガー
   └─ pull_request_targetイベントで起動
2. リポジトリチェックアウト
   └─ actions/checkout@v4でPRのHEAD SHAをチェックアウト
3. airインストール
   └─ posit-dev/setup-air@v1でairフォーマッターをインストール
4. コードフォーマット
   └─ air format .で全Rファイルをフォーマット
5. 修正提案コメント
   └─ reviewdog/action-suggester@v1でPRに修正提案をコメント
```

### フローチャート

```mermaid
flowchart TD
    A[PR作成/更新] --> B[PR HEAD SHAチェックアウト]
    B --> C[airインストール]
    C --> D[air format実行]
    D --> E{フォーマット差分あり?}
    E -->|Yes| F[reviewdogで修正提案コメント]
    E -->|No| G[ジョブ完了]
    F --> H{エラーレベル判定}
    H -->|error| I[ジョブ失敗]
    H -->|warning| G
    I --> G
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | 本バッチはデータベースを使用しない |

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

本バッチはデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | フォーマットエラー | airがパースできないRファイルがある | 構文エラーを修正 |
| - | reviewdogエラー | PRへのコメント投稿に失敗 | 権限設定を確認 |
| - | fail_level: error | フォーマット違反がある | 提案された修正を適用 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 手動で再実行可能 |
| リトライ間隔 | N/A |
| リトライ対象エラー | 一時的なネットワークエラー等 |

### 障害時対応

エラー発生時は、GitHub Actions UIでログを確認し、エラー原因を特定して修正。フォーマット違反によるエラーの場合は、PRに投稿された修正提案を適用する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A（コード変更なし） |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リポジトリ内全Rファイル |
| 目標処理時間 | 1-5分 |
| メモリ使用量上限 | GitHub Actions標準 |

## 排他制御

並列実行を許可。複数のPRが同時にフォーマットチェックを実行しても問題ない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| フォーマットログ | air format実行時 | フォーマット対象ファイル一覧 |
| reviewdogログ | 提案投稿時 | 投稿した提案の概要 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー失敗 | 1件以上 | GitHub通知、PRステータス |

## 備考

- pull_request_targetを使用する理由は、フォークからのPRに対してもpull-requests: write権限を持って実行できるため
- pull_request_targetはターゲットブランチ（通常はmain）のコンテキストで実行されるため、セキュリティ上の注意が必要
- ref: ${{ github.event.pull_request.head.sha }}により、PRのHEAD（コントリビューターのコード）をチェックアウト
- GitHubのセキュリティガイドラインによると、フォーマットと修正提案のユースケースは安全とされている（コードを実行せず、データとして扱うため）
- level: errorおよびfail_level: errorにより、フォーマット違反があるとワークフローが失敗する
- tool_name: airにより、reviewdogのコメントにairフォーマッターを識別する名前が付与される
