本文へスキップ
SpecifyDocs

ドキュメント自動化

GitHubの接続

ワークスペースにGitHubアカウントとリポジトリを接続する方法と、組織リポジトリの承認手順を説明します。

SpecifyはGitHubリポジトリをドキュメントの根拠として使います。リポジトリを接続すると、エージェントがコードを読み取ってドキュメントを生成し、以降の変更を修正案として用意できるようになります。

GitHubは2か所から接続できます。

  • ドキュメントプロジェクトの作成のソースのステップにあるGitHub を接続 — ドキュメント生成の根拠となるリポジトリを選びます。
  • ツールとスキル → コネクタ → GitHubの連携 — チャットでエージェントがコードとイシュー・PRをあわせて参照できるようにします。コネクターの接続を参照してください。

接続の流れ

  1. GitHubの接続を開始する

    ドキュメントプロジェクトの作成画面のソースのステップでGitHub を接続を選択します。このワークスペースでリポジトリを選択するには、まずGitHubを接続する必要があります。

    ドキュメントプロジェクト作成のソースのステップ。「このワークスペースでリポジトリを選ぶには GitHub を接続してください。」という案内とGitHub を接続ボタン
  2. GitHubでアクセスを許可する

    GitHubの画面に移動したら、Specifyが読み取るアカウントとリポジトリの範囲を選択して許可します。

  3. リポジトリとブランチを選択する

    Specifyに戻ったらGitHub アカウントを選び、リポジトリ名で検索して選択してから、ブランチを選びます。一覧を読み込めない場合は、owner/repo形式で直接入力することもできます。

組織リポジトリ

組織リポジトリには、GitHub組織の管理者の承認が必要です。

  1. 接続をリクエストすると、GitHubが組織の管理者に承認リクエストを送ります。
  2. 組織の管理者がGitHubでリクエストを承認します。
  3. 承認が完了したら、Specifyの画面で再接続を押して完了します。

組織の管理者の承認を待っている間は、その組織のリポジトリは一覧に表示されません。

チャットでGitHubを使う

コネクターでGitHubを連携すると、エージェントがリポジトリのコード・ファイル内容、イシュー・PRとコメント、コミット履歴を読み取り、コード検索やイシュー・PRの要約などの作業を行えるようになります。

GitHubコネクターの詳細ウィンドウ。ワークスペースに連携ボタンと、エージェントが読むデータ、エージェントに任せられる作業の一覧が表示されている
ツールとスキル → コネクタでGitHubを押すと開く詳細ウィンドウです。

複数のリポジトリを接続する

1つのドキュメントプロジェクトに複数のソースを追加できます。プロジェクト設定のソース項目で、ドキュメントの根拠として使うリポジトリとブランチを追加または削除します。各ソースには役割を指定できます。

push時に実行

ソースごとにpush で実行をオンにすると、そのブランチにコードをpushしたときにもドキュメントの修正案を用意します。詳しい設定は自動化の詳細設定を参照してください。

トラブルシューティング

症状確認すること
リポジトリを読み込めないしばらくしてから再試行するか、手動で入力でowner/repoを入力します。
利用できるリポジトリがない選択したGitHubアカウントで、Specifyへのアクセスを許可したリポジトリがあるか確認します。
利用できるブランチがないリポジトリにブランチがあるか、アクセス権限があるかを確認します。
組織リポジトリが表示されない組織の管理者の承認が完了しているかを確認してから、再接続を押します。