# バッチ設計書 5-pkgdown

## 概要

本ドキュメントは、GitHub Actionsを使用してpkgdownによるパッケージドキュメントサイトを自動生成し、GitHub Pagesにデプロイするワークフローの設計書である。

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

このバッチは、GitHubへのpush、Pull Request作成、リリース公開、または手動トリガーにより実行され、pkgdownパッケージを使用してdplyrの公式ドキュメントサイトを生成し、GitHub Pagesにデプロイする処理を行う。

**業務上の目的・背景**：pkgdownは、Rパッケージのドキュメント、関数リファレンス、ビネット（チュートリアル）を美しいウェブサイトとして自動生成するツールである。dplyrのような広く利用されるパッケージでは、ユーザーがオンラインで簡単にドキュメントを参照できることが重要であり、GitHub Pagesを通じて公開することで、常に最新のドキュメントを提供できる。

**バッチの実行タイミング**：mainまたはmasterブランチへのpush時、Pull Request時（ビルドのみ、デプロイなし）、リリース公開時、および手動実行（workflow_dispatch）時に実行される。

**主要な処理内容**：
1. リポジトリのチェックアウト
2. pandocのセットアップ
3. Rのセットアップ
4. パッケージ依存関係のインストール（pkgdown含む）
5. pkgdown::build_site_github_pages()によるサイト生成
6. GitHub Pagesへのデプロイ（PR以外の場合）

**前後の処理との関連**：R-CMD-checkワークフローと並行して実行されることがある。リリース時には特に重要で、新しいバージョンのドキュメントを公開する役割を果たす。

**影響範囲**：gh-pagesブランチおよびGitHub Pagesサイトが更新される。公式ドキュメントサイト（https://dplyr.tidyverse.org等）の内容に影響する。

## バッチ種別

CI/CD（ドキュメント生成・デプロイ）

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actionsの有効化 | リポジトリでGitHub Actionsが有効であること |
| GITHUB_TOKEN | シークレットとしてGITHUB_TOKENが利用可能であること |
| GitHub Pages設定 | gh-pagesブランチがGitHub Pagesのソースとして設定されていること |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| リポジトリコード | Git | チェックアウトされたソースコード |
| DESCRIPTION | テキスト | パッケージメタデータ |
| man/*.Rd | Rd形式 | 関数ドキュメント |
| vignettes/*.Rmd | R Markdown | ビネット |
| _pkgdown.yml | YAML | pkgdown設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| docs/ | HTML/CSS/JS | 生成されたドキュメントサイト |
| gh-pagesブランチ | Git | デプロイ先ブランチ |
| GitHub Pages | Web | 公開ドキュメントサイト |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | index.html、reference/、articles/等 |
| 出力先 | docs/（ローカル）、gh-pagesブランチ（デプロイ） |
| 文字コード | UTF-8 |
| 区切り文字 | N/A（HTML形式） |

## 処理フロー

### 処理シーケンス

```
1. ワークフロートリガー
   └─ push/pull_request/release/workflow_dispatchイベントで起動
2. 同時実行制御
   └─ 非PRジョブは同一グループ内で排他実行
3. リポジトリチェックアウト
   └─ actions/checkout@v4でソースコード取得
4. pandocセットアップ
   └─ r-lib/actions/setup-pandoc@v2でドキュメント変換用
5. Rセットアップ
   └─ r-lib/actions/setup-r@v2でRをインストール
6. 依存関係インストール
   └─ r-lib/actions/setup-r-dependencies@v2でpkgdown含む依存パッケージをインストール
7. サイト生成
   └─ pkgdown::build_site_github_pages()でHTMLサイトを生成
8. GitHub Pagesへのデプロイ
   └─ PR以外の場合、JamesIves/github-pages-deploy-action@v4.5.0でgh-pagesブランチにデプロイ
```

### フローチャート

```mermaid
flowchart TD
    A[イベント発生] --> B{トリガー判定}
    B -->|push/release/dispatch| C[同時実行制御]
    B -->|pull_request| D[PR用ビルド]
    C --> E[チェックアウト]
    D --> E
    E --> F[pandocセットアップ]
    F --> G[Rセットアップ]
    G --> H[依存関係インストール]
    H --> I[pkgdownサイト生成]
    I --> J{PRかどうか}
    J -->|PR| K[ビルドのみ完了]
    J -->|PR以外| L[GitHub Pagesデプロイ]
    L --> M[ジョブ完了]
    K --> M
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | pkgdownビルドエラー | Rdファイルやビネットにエラーがある | ドキュメントの構文エラーを修正 |
| - | 依存関係エラー | パッケージインストール失敗 | DESCRIPTIONの依存関係を確認 |
| - | デプロイエラー | GitHub Pagesへのプッシュ失敗 | 権限設定を確認 |

### リトライ仕様

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

### 障害時対応

エラー発生時は、GitHub Actions UIでログを確認し、エラー原因を特定して修正。pkgdownのビルドエラーは、ローカル環境でpkgdown::build_site()を実行してデバッグ可能。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | デプロイ時にgh-pagesブランチにコミット |
| ロールバック条件 | 手動でgh-pagesブランチをリバート |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1サイト生成 |
| 目標処理時間 | 5-15分 |
| メモリ使用量上限 | GitHub Actions標準 |

## 排他制御

非PRジョブは同一グループ（pkgdown-{event_name/run_id}）内で排他実行される。これにより、同時にデプロイが実行されることを防止する。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ステップログ | 各ステップ実行時 | コマンド出力、エラーメッセージ |
| pkgdownログ | サイト生成時 | 生成されたページ一覧 |
| デプロイログ | デプロイ時 | デプロイ先ブランチ、コミット情報 |

## 監視・アラート

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

## 備考

- permissions: contents: writeにより、gh-pagesブランチへの書き込み権限を付与
- concurrencyグループにより、非PRジョブは排他実行される
- new_process = FALSE、install = FALSEオプションにより、ビルド時間を短縮
- clean: falseにより、デプロイ時に既存ファイルを削除しない（インクリメンタルデプロイ）
- PRの場合はデプロイをスキップし、ビルドのみを実行して構文チェックを行う
