Copilot を使って自動コード レビューを構成する

リポジトリ内の pull request を自動的にレビューするように Copilot を構成する方法について説明します。

この記事の内容

自動コード レビューについて

既定で Copilot によって pull request がレビューされるのは、人間のレビュー担当者を割り当てる場合と同じ方法でその pull request に割り当てられた場合のみです。 ただし、リポジトリ所有者は、リポジトリ内のすべての pull request を自動的にレビューするように Copilot を構成できます。 Organization 所有者は、organization 内の一部またはすべてのリポジトリにあるすべての pull request を自動的にレビューするように Copilot を構成できます。

自動 pull request レビューをトリガーする

自動コード レビューを構成すると、次の状況で Copilot によって pull request がレビューされます。

  • Pull request が "オープン" pull request として作成されたとき。

    Pull request が "ドラフト" pull request として作成された場合、レビューはトリガーされません。

  • "ドラフト" pull request が初めて "オープン" に切り替えられたとき。

Note

Copilot によって pull request が自動的にレビューされるのは、1 回だけです。 自動的にレビューされた後に pull request に変更を加え、Copilot による pull request の再レビューを受けたい場合は、手動で要求する必要があります。 これを行うには、[Reviewers] メニューの Copilot の名前の横にある ボタンをクリックします。

1 つのリポジトリに対して自動コード レビューを構成する

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  3. 左側のサイド バーの [コードと自動化] の下で、 [ルール] をクリックし、 [ルールセット] をクリックします。

    リポジトリの [設定] ページのサイド バーのスクリーンショット。 [ルール] サブメニューが展開され、[ルールセット] オプションの枠線がオレンジ色で表示されています。

  4. 「新しいルールセット」をクリックします。

  5. [新しいブランチ ルールセット] をクリックします。

  6. [ルールセット名] に、ルールセットの名前を入力します。

  7. [Target branches] で [Add target] をクリックし、オプションのいずれかを選びます。たとえば、[Include default branch] または [Include all branches] などです。

  8. [Branch rules] で、[Require a pull request before merging] チェックボックスをオンにします。

    これにより、一連の補助的なオプションが展開されます。

  9. [Request pull request review from Copilot] チェックボックスをオンにします。

    [Request pull request review from Copilot] ブランチ ルールセット オプションのスクリーンショット。

  10. ページの下部にある [Create] をクリックします。

Organization のリポジトリについて自動コード レビューを構成する

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. 組織の隣の [設定] をクリックします。

  3. 左のサイド バーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。

    組織の設定ページのスクリーンショット。 サイド バーで、[ルールセット] というラベルの付いたリンクがオレンジ色の枠線で囲まれています。

  4. 「新しいルールセット」をクリックします。

  5. [新しいブランチ ルールセット] をクリックします。

  6. [ルールセット名] に、ルールセットの名前を入力します。

  7. [Target repositories] で、[Add target] をクリックし、[Include by pattern] または [Exclude by pattern] を選びます。

  8. 表示されるダイアログ ボックスに、organization 内のリポジトリの名前と一致するパターンを入力します。たとえば、名前が feature で終わるすべてのリポジトリと一致するようにするには、「*feature」と入力します。

    パターンマッチング構文の詳細については、「組織内のリポジトリのルールセットを作成する」を参照してください。

  9. ダイアログ ボックスで、[Add inclusion pattern] または [Add exclusion pattern] をクリックします。

  10. 追加するパターンがある場合は、このプロセスを繰り返します。

    Note

    複数のターゲット条件を同じルールセットに追加できます。 除外パターンは包含パターンの後に適用されます。 たとえば、パターン *cat* に一致するリポジトリを含め、パターン not-a-cat に一致するリポジトリを明示的に除外できます。

  11. [Target branches] で、[Add target] をクリックし、ターゲット オプションのいずれかを選びます。

  12. [Branch rules] で、[Require a pull request before merging] チェックボックスをオンにします。

    これにより、一連の補助的なオプションが展開されます。

  13. [Request pull request review from Copilot] チェックボックスをオンにします。

  14. ページの下部にある [Create] をクリックします。