Copilot を使って pull request に関する作業を支援する

Note

Copilot Workspace は現在パブリックプレビュー段階であり、変更される可能性があります。

Copilot を使って pull request に関する作業を支援する方法について

pull request を作成した後、GitHub の Web サイト上で PR の作業を続けることができます。この記事では、Copilot Workspace について説明します。これには、次を実行するための Copilot 対応の環境が用意されています。

pull request の調整
変更の検証
レビュー担当者からの提案の統合

Copilot Workspace を使えば、pull request の作成からマージまで、pull request に関する作業を 1 か所で (GitHub で) 行うことができます。

Copilot を他の方法で pull request に役立てることもできます。それらについては、別の記事で説明します。 Copilot で次のことができます。

pull request の要約を自動的に作成 - 「GitHub Copilot で pull request の概要を作成する」を参照。
pull request を自動的にレビュー - 「GitHub Copilot コードレビューの使用」を参照。
CodeQL code scanning によって特定されたコーディングの問題の修正を提案 - 「コードスキャンに対する Copilot Autofix の責任ある使用」を参照。

Copilot Workspace の利点

Copilot Workspace を使えば:

GitHub Web サイトと IDE 間で切り替えを行わずに pull request に関する作業を行うことができます。
Copilot コードレビューや Copilot Autofix、または人間のレビュー担当者によるレビューからのコーディングの提案を、簡単に表示、テスト、変更、適用できます。
Copilot コード補完候補を GitHub で利用できます。以前は、IDE でしか利用できませんでした。
ブラウザーベースのエディター内で、pull request によって変更されるファイルの一覧を表示できます。リポジトリ全体から任意のファイルを検索して編集することもできます。
GitHub 上の Workspace 環境から直接コードをビルド、テスト、実行できます。

前提条件

Copilot Workspace を使うには、以下が必要です。

Copilot サブスクリプション。詳しくは、「GitHub Copilot のサブスクリプションプラン」を参照してください。
順番待ちリストからのパブリックプレビューへの参加。順番待ちリストへの参加を申し込むには、Copilot コードレビューの順番待ちリストへの参加に関するページを参照してください。
GitHub Web サイト上に既存の pull request があること。 pull request の作成方法についてサポートが必要な場合は、「pull request の作成」を参照してください。

Copilot Workspace にアクセスしなくても、pull request 内のファイルを編集できます。それには、[Files changed] タブに移動し、編集するファイルの横にある省略記号 ([...]) をクリックして、[Edit file] をクリックします。

pull request 内のファイルを編集する

Copilot Workspace で pull request に関する作業を行うには:

pull request のメインページの右側にある [ Open in Workspace] ボタンをクリックします。

Copilot Workspace が開き、pull request の概要が表示されます。

Copilot Workspace ウィンドウの左側には、pull request によって変更されるファイルの一覧が表示されます。
現在この pull request によって変更されていないファイルを操作するには、[Files in this pull request] をクリックし、ドロップダウンから [All files in this repository] を選択します。
一覧内のファイルをクリックして、Workspace エディターでファイルを開きます。

ファイルは diff ビューで表示されます。このビューは必要に応じて変更できます。この記事の後半にある「Workspace オプションの変更」を参照してください。

複数のファイルを開いて変更してから、変更をコミットできます。
変更が完了したら、[Review and commit] をクリックします。

[Commit changes] パネルが表示されます。行った変更に基づいて、Copilot がコミットメッセージを自動生成します。必要に応じて、このメッセージを編集したり、詳しい説明を追加したりできます。

パネルには、変更したファイルが一覧表示されます。各ファイルを展開して、行った変更を確認できます。
必要に応じて、複数のファイルを編集した後に 1 回のコミットですべての変更をコミットしたくないと思った場合は、変更をコミットしないファイルの横にあるチェックボックスをオフにします。 [Commit changes] をクリックすると、それらのファイルに適用した変更は適用されたままですが、コミットはされず、別のコミットで pull request に追加できます。

Note

ファイルの横にあるチェックボックスをオフにした場合は、そのファイルの変更には言及しないようにコミットメッセージを書き直す必要があるかもしれません。
[変更をコミットする] をクリックします。

または、[Reset all changes] をクリックして、ファイルを pull request内の現在の状態に戻します。Workspace エディターパネル内で行った変更内容は失われます。変更内容のリセットを取り消すことはできません。

Copilot を使って pull request のコメントに関する作業を行う

Copilot Workspace を使って pull request のすべてのコメントを 1 つずつ処理してから、1 回のコミットで、行うことにしたすべての変更をコミットできます。

コード変更の提案を含むコメントで、[Open in Workspace] をクリックします。

Copilot Workspace が開き、Workspace ウィンドウの右側にある [Suggestions] パネルに提案された変更が表示されます。
提案された変更を確認し、[Suggestions] パネルの下部にある 2 つのボタンのいずれかをクリックします。
- [Apply] - 提案された変更に同意する場合。
- [Dismiss] - 提案された変更を行いたくない場合。
pull request に複数のコメントがある場合は、[Suggestions] パネルの下部にある矢印 [>] をクリックすれば、次のコメントを処理できます。
必要に応じて、pull request のすべてのコメントを一覧表示するには、[Suggestions] パネルの左上の戻る矢印をクリックします。

同意した提案と却下した提案は、[applied] と [dismissed] のドロップダウンに表示されます。これにより、まだ処理していない提案はどれか簡単にわかります。
提案された変更のレビューが完了したら、[Review and commit] をクリックします。
必要に応じて、適用した変更のすべてを 1 回のコミットでコミットしたくないと思った場合は、変更をコミットしないファイルの横にあるチェックボックスをオフにします。 [Commit changes] をクリックすると、それらのファイルに適用した変更は適用されたままですが、コミットはされず、別のコミットで pull request に追加できます。
[変更をコミットする] をクリックします。

または、[Reset all changes] をクリックして提案を最初の状態に戻します。行った同意または却下の選択は失われ、Workspace エディターパネルで直接ファイルを編集して行った変更内容も失われます。変更内容のリセットを取り消すことはできません。

pull request について Copilot とチャットする

Workspace ウィンドウの上部にあるボタンをクリックします。
Copilot パネルの下部にある [Ask Copilot] ボックスに質問を入力して、Enter を押します。

次に関する質問をすることができます。
- 現在表示されているファイル - 例:「このファイルを改善するにはどうすればよいですか?」
- pull request 全体 - 例:「この pull request で参照されるフレームワークは何ですか?」
- プログラミングに関する一般的なトピック - 例:「Ruby の最新バージョンは何ですか?」
詳しくは、「GitHub で GitHub Copilot に質問をする」を参照してください。

Note

現在、Copilot Workspace のパブリックプレビュー段階では Copilot Chat のすべての機能をご利用いただけません。

変更を検証する

Workspace には、組み込みのターミナルと、コードをビルド、実行、テストするための簡単な方法が用意されています。

ターミナルを開く

ターミナルを開くには、Workspace エディターパネルの右上にあるをクリックします。

Note

ターミナルを使うには、codespace が実行中である必要があります。アイコンが表示されないときは、codespace が起動するまで数秒待つ必要がある場合があります。

ターミナルコマンドの実行

ターミナルに直接コマンドを入力することも、クイックコマンドを使ってよく使われるコマンドを数クリックで実行することもできます。

個人用のクイックコマンドを構成する

Copilot Workspace で特定のプロジェクトに取り組むときに使用できる、Build、Run、Test コマンドを構成できます。リポジトリに対して既にコマンドが構成されている場合は、個人で使うための代わりのコマンドでそれらを置き換えることができます。

Workspace ウィンドウの上部にある [ Configure] をクリックします。

Build、Run、Test のクイックコマンドが既に定義されている場合は、[ Configure] の代わりに [ Build] ボタンが表示されます。 [ Build] ボタンの横にあるドロップダウン矢印をクリックしてから、ドロップダウンメニューの [ Configure] をクリックします。
[Configure commands] ダイアログで、Build、Run、Test のオプションに使いたいコマンドを入力します。
[保存] をクリックします。

リポジトリのクイックコマンドを構成する

Copilot Workspace を使って自分のリポジトリの pull request に関する作業を行う全員に対して、既定の Build、Run、Test コマンドを定義できます。

リポジトリのルートに .devcontainer/devcontainer.json という名前のファイルを作成するか、それを編集します。

Note

.devcontainer/devcontainer.json ファイルは、リポジトリ用に作成される codespace の構成ファイルです。詳しくは、「開発コンテナーの概要」を参照してください。
次のように commands セクションを追加します。以下のコマンドの例は、そのリポジトリで作業するユーザーが使うべきコマンドに置き換えてください。
```
{
  "commands": {
    "Build": "make",
    "Run": "./bin/start",
    "Test": "make test"
  }
}
```
[保存] をクリックします。

Workspace クイックコマンドの使用

定義済みクイックコマンドの最初のコマンド (通常は Build) を実行するには、Workspace ウィンドウの上部にあるボタンをクリックします。
別のクイックコマンドを実行するには、ボタンの横にあるドロップダウン矢印をクリックし、ドロップダウンメニューから実行したいコマンドをクリックします。
[Run] をクリックした後、プロセスの実行中に、ドロップダウン矢印をもう一度クリックして、プロセスを停止または再起動するオプション、または実行コマンドの出力を表示するオプションを選択できます。

Workspace エディターパネルの右上にある比較ピッカーアイコン () をクリックします。
ビューオプションを選択します。
- Unified - 1 つのビューに変更を表示します。追加された線は緑色で強調表示され、削除された行は赤で強調表示されます。
- Split - 分割ビューに変更を表示します。元のファイルは左側に、新しいファイルは右側に表示されます。
- Hidden - この pull request 内のファイルの現在の状態を表示し、PR が行う変更は表示しません。

長い行の折り返し

Workspace エディターパネルの右上にある省略記号 ([...]) をクリックします。
[Wrap lines] をクリックして、行の折り返しのオンとオフを切り替えます。

Copilot を使って pull request に関する作業を支援する

この記事の内容