GitHub連携

Guidebook CloudはGitHub Appを通じてGitHubと連携します。この連携により、リポジトリへのプッシュ時に自動的にドキュメントがビルド・デプロイされます。

GitHub Appのインストール

インストール手順

  1. コンソールにログイン
  2. サイドバーの「設定」→「GitHub」を開く
  3. 「GitHub Appをインストール」をクリック
  4. GitHubの認証画面が表示される
  5. アクセスを許可する組織またはアカウントを選択
  6. 連携するリポジトリを選択：
    • 「All repositories」: すべてのリポジトリ
    • 「Only select repositories」: 特定のリポジトリのみ
  7. 「Install」をクリック

必要な権限

GitHub Appは以下の権限を要求します：

権限用途
Contents (Read)リポジトリのファイル読み取り
Metadata (Read)リポジトリ情報の取得
Webhooksプッシュイベントの受信

自動デプロイ

仕組み

  1. GitHubリポジトリにプッシュ
  2. GitHubからWebhookが送信される
  3. Guidebook Cloudがビルドジョブをキューに追加
  4. ビルドワーカーがドキュメントをビルド
  5. 成果物をR2ストレージにアップロード
  6. ドキュメントが公開される

デプロイトリガー

以下のイベントでデプロイがトリガーされます：

  • Push: ブランチへのプッシュ
  • Create: 新しいブランチの作成

ビルドステータス

ビルドの状態は以下のいずれかです：

ステータス説明
queuedキューに追加済み、ビルド待ち
pendingビルド準備中
buildingビルド実行中
successビルド成功
failedビルド失敗
cancelledユーザーによりキャンセル

インストールの管理

リポジトリの追加・削除

インストール後にアクセス可能なリポジトリを変更できます：

  1. GitHub App設定ページを開く
  2. 「Guidebook Cloud」を選択
  3. 「Configure」をクリック
  4. 「Repository access」でリポジトリを追加・削除
  5. 「Save」をクリック

アンインストール

GitHub Appをアンインストールするには：

  1. GitHub App設定ページを開く
  2. 「Guidebook Cloud」を選択
  3. 「Uninstall」をクリック

注意: アンインストールすると、該当組織のすべてのリポジトリで自動デプロイが停止します。

トラブルシューティング

ビルドがトリガーされない

  1. GitHub Appがインストールされているか確認
  2. リポジトリへのアクセス権があるか確認
  3. Webhookの配信状況を確認

ビルドが失敗する

  1. ビルドログを確認
  2. SUMMARY.mdが正しい形式か確認
  3. ドキュメントパスが正しいか確認

権限エラー

GitHub Appに必要な権限がない場合：

  1. GitHub App設定ページを開く
  2. 「Permissions」を確認
  3. 必要に応じて権限を更新