# バッチ設計書 10-rhub

## 概要

本ドキュメントは、GitHub Actionsを使用してR-hubプラットフォームでのパッケージチェックを実行するワークフローの設計書である。

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

このバッチは、手動トリガー（workflow_dispatch）により実行され、R-hubプラットフォームを使用してdplyrパッケージを複数の環境（Linux、Windows、macOS）でチェックする処理を行う。R-hubは、CRANへのパッケージ投稿前の最終チェックや、特定の環境での問題調査に使用される。

**業務上の目的・背景**：CRANにパッケージを投稿する前に、様々な環境でパッケージが正しく動作することを確認する必要がある。R-hubは、CRANが使用する環境に近い環境でのチェックを提供し、CRANチェック通過の可能性を高める。また、ユーザーから特定の環境での問題が報告された場合、その環境を再現してデバッグするためにも使用される。

**バッチの実行タイミング**：手動実行（workflow_dispatch）のみ。CRANへのリリース前や、環境固有の問題調査時に開発者が明示的に実行する。

**主要な処理内容**：
1. R-hubセットアップによるプラットフォーム設定の読み取り
2. Linuxコンテナでのチェック（条件付き）
3. Windows/macOSでのチェック（条件付き）
4. 各プラットフォームでの依存関係インストール
5. R CMD checkの実行

**前後の処理との関連**：R-CMD-checkワークフローは日常的なCI/CDに使用され、rhubワークフローはリリース前の最終確認や特定環境でのデバッグに使用される。

**影響範囲**：R-hubプラットフォーム上でのチェック結果が報告される。CRANへの投稿判断に影響する。

## バッチ種別

CI/CD（R-hubプラットフォームチェック）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | N/A（手動実行時） |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | workflow_dispatch |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actionsの有効化 | リポジトリでGitHub Actionsが有効であること |
| RHUB_TOKEN | シークレットとしてRHUB_TOKENが設定されていること |

### 実行可否判定

手動実行（workflow_dispatch）により、開発者の判断で実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| config | string | No | 'linux,windows,macos' | カンマ区切りのR-hubプラットフォームリスト |
| name | string | No | - | 実行名（オプション） |
| id | string | No | - | ユニークID（オプション） |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHub Actions ログ | テキスト | 各プラットフォームでのチェック結果 |
| R-hub レポート | Web | R-hubダッシュボード上のレポート |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. ワークフロートリガー
   └─ workflow_dispatchイベントで手動起動
2. セットアップジョブ
   └─ r-hub/actions/setup@v1でプラットフォーム設定を読み取り
3. Linuxコンテナジョブ（条件付き）
   └─ containersが空でない場合に実行
   └─ Dockerコンテナ内でR CMD checkを実行
4. その他プラットフォームジョブ（条件付き）
   └─ platformsが空でない場合に実行
   └─ Windows/macOSでR CMD checkを実行
5. 各ジョブの共通処理
   └─ チェックアウト → Rセットアップ → 依存関係インストール → チェック実行
```

### フローチャート

```mermaid
flowchart TD
    A[手動トリガー] --> B[セットアップジョブ]
    B --> C{containers出力}
    B --> D{platforms出力}
    C -->|空でない| E[Linux コンテナジョブ]
    C -->|空| F[スキップ]
    D -->|空でない| G[その他プラットフォームジョブ]
    D -->|空| H[スキップ]
    E --> I[チェックアウト]
    G --> J[チェックアウト]
    I --> K[プラットフォーム情報表示]
    J --> L[Rセットアップ]
    K --> M[依存関係インストール]
    L --> N[プラットフォーム情報表示]
    M --> O[R CMD check実行]
    N --> P[依存関係インストール]
    P --> Q[R CMD check実行]
    O --> R[ジョブ完了]
    Q --> R
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

エラー発生時は、GitHub Actions UIでログを確認し、エラー原因を特定して修正。R-hub固有の問題の場合は、rhub2パッケージのドキュメントやR-hubのサポートを参照。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 複数プラットフォームでのチェック |
| 目標処理時間 | 30分〜1時間（プラットフォーム数に依存） |
| メモリ使用量上限 | GitHub Actions標準 |

## 排他制御

並列実行を許可。fail-fast: falseにより、一部のプラットフォームでチェックが失敗しても他のプラットフォームのチェックは継続される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| プラットフォーム情報 | セットアップ後 | R-hubプラットフォーム設定 |
| チェックログ | R CMD check完了時 | WARNING、NOTE、ERROR一覧 |

## 監視・アラート

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

## 備考

- ワークフローはr-hub/actions/v1を使用
- rhub::rhub_setup()で最新のワークフローに更新可能
- run-nameにより、GitHubのActions UIで実行名を表示
- configパラメータで実行するプラットフォームをカスタマイズ可能
- linux-containersジョブはDockerコンテナを使用し、Linuxの様々なディストリビューションをテスト
- other-platformsジョブはGitHub Actions標準のランナーを使用
- RHUB_TOKENはR-hubサービスとの認証に使用
- fail-fast: falseにより、一部のプラットフォームで失敗しても全プラットフォームのテスト結果を取得

### サポートされるプラットフォーム

R-hubは以下のような環境をサポート：
- Linux（Ubuntu、Fedora、Debian等の様々なバージョン）
- Windows（release、devel）
- macOS（Intel、ARM）

具体的なプラットフォームリストはr-hub/actionsのドキュメントを参照。
