# バッチ設計書 4-R-CMD-check

## 概要

本ドキュメントは、GitHub Actionsを使用してdplyrパッケージに対するR CMD check（Rパッケージの標準チェック）を複数のOS・Rバージョンで自動実行するCI/CDワークフローの設計書である。

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

このバッチは、GitHubへのpushまたはPull Request作成時に自動的にトリガーされ、dplyrパッケージがRの公式品質基準を満たしているかを検証する。macOS、Windows、Ubuntuの各プラットフォームで、複数のRバージョンに対してテストを実行し、パッケージの互換性を確保する。

**業務上の目的・背景**：CRANに公開されるRパッケージは、R CMD checkによる品質チェックをパスする必要がある。dplyrは広く利用されるパッケージであり、複数のプラットフォームおよびRバージョンでの動作保証が求められる。継続的インテグレーションにより、コード変更がパッケージの品質に悪影響を与えていないかを早期に検出し、リグレッションを防止する。

**バッチの実行タイミング**：mainまたはmasterブランチへのpush時、およびPull Request作成・更新時に自動実行される。

**主要な処理内容**：
1. リポジトリのチェックアウト
2. pandocのセットアップ
3. 指定バージョンのRのセットアップ
4. パッケージ依存関係のインストール
5. R CMD checkの実行
6. テストスナップショットのアップロード（オプション）

**前後の処理との関連**：他のCI/CDワークフロー（test-coverage、pkgdown等）と並行して実行される。本ワークフローの成功がPRのマージ可否判断に使用される。

**影響範囲**：パッケージのビルドおよびテスト結果に影響。CRANへのリリース判断の基準となる。

## バッチ種別

CI/CD（継続的インテグレーション）

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actionsの有効化 | リポジトリでGitHub Actionsが有効であること |
| GITHUB_TOKEN | シークレットとしてGITHUB_TOKENが利用可能であること |
| R-lib/actions | r-lib/actionsワークフローが利用可能であること |

### 実行可否判定

GitHubイベント（push/pull_request）により自動的に実行判定される。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| リポジトリコード | Git | チェックアウトされたソースコード |
| DESCRIPTION | テキスト | パッケージメタデータ・依存関係 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHub Actions ログ | テキスト | チェック結果の詳細ログ |
| テストスナップショット | アーティファクト | テスト結果のスナップショット（オプション） |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. ワークフロートリガー
   └─ push（main/master）またはpull_requestイベントで起動
2. マトリクス展開
   └─ 9つのOS/Rバージョン組み合わせでジョブを並列実行
3. リポジトリチェックアウト
   └─ actions/checkout@v4でソースコード取得
4. pandocセットアップ
   └─ r-lib/actions/setup-pandoc@v2でドキュメント生成用
5. Rセットアップ
   └─ r-lib/actions/setup-r@v2で指定バージョンをインストール
6. 依存関係インストール
   └─ r-lib/actions/setup-r-dependencies@v2で依存パッケージをインストール
7. R CMD check実行
   └─ r-lib/actions/check-r-package@v2でパッケージチェック
8. 結果アップロード
   └─ スナップショットをアーティファクトとしてアップロード
```

### フローチャート

```mermaid
flowchart TD
    A[イベント発生] --> B{トリガー判定}
    B -->|push/PR| C[マトリクス展開]
    C --> D[macOS-latest/release]
    C --> E[windows-latest/release]
    C --> F[windows-latest/oldrel-4]
    C --> G[ubuntu-latest/devel]
    C --> H[ubuntu-latest/release]
    C --> I[ubuntu-latest/oldrel-1]
    C --> J[ubuntu-latest/oldrel-2]
    C --> K[ubuntu-latest/oldrel-3]
    C --> L[ubuntu-latest/oldrel-4]
    D & E & F & G & H & I & J & K & L --> M[チェックアウト]
    M --> N[pandocセットアップ]
    N --> O[Rセットアップ]
    O --> P[依存関係インストール]
    P --> Q[R CMD check実行]
    Q --> R[スナップショットアップロード]
    R --> S[ジョブ完了]
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | R CMD checkエラー | パッケージチェック失敗 | エラー内容を確認し、コードを修正 |
| - | 依存関係エラー | パッケージインストール失敗 | DESCRIPTIONの依存関係を確認 |
| - | ビルドエラー | パッケージビルド失敗 | ソースコードのエラーを修正 |

### リトライ仕様

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

### 障害時対応

エラー発生時は、GitHub Actions UIでログを確認し、エラー原因を特定して修正。fail-fast: falseにより、一部のジョブが失敗しても他のジョブは継続実行される。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 9ジョブ並列実行 |
| 目標処理時間 | 10-30分（全ジョブ完了まで） |
| メモリ使用量上限 | GitHub Actions標準 |

## 排他制御

並列実行を許可。fail-fast: falseにより、失敗したジョブがあっても他のジョブは継続実行される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ステップログ | 各ステップ実行時 | コマンド出力、エラーメッセージ |
| チェックログ | R CMD check完了時 | WARNING、NOTE、ERROR一覧 |

## 監視・アラート

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

## 備考

- ワークフローはr-lib/actionsのv2サンプルを基にしている
- build_argsに`--no-manual`と`--compact-vignettes=gs+qpdf`を指定し、ビルド時間を短縮
- permissions: read-allにより、最小限の権限で実行
- R_KEEP_PKG_SOURCE: yesにより、デバッグ用にソースを保持
- http-user-agentはdevel版でのみ'release'を指定（RSPM互換性のため）

### マトリクス構成

| OS | Rバージョン | 備考 |
|-----|------------|------|
| macos-latest | release | 最新安定版 |
| windows-latest | release | 最新安定版 |
| windows-latest | oldrel-4 | rtools40互換性確認 |
| ubuntu-latest | devel | 開発版 |
| ubuntu-latest | release | 最新安定版 |
| ubuntu-latest | oldrel-1 | 1世代前 |
| ubuntu-latest | oldrel-2 | 2世代前 |
| ubuntu-latest | oldrel-3 | 3世代前 |
| ubuntu-latest | oldrel-4 | 4世代前 |
