Skip to content

Commit 676e02f

Browse files
ria-gopuCopilotCopilot
authored
Update code review runner docs to recommend copilot-code-review.yml (#62412)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Copilot-Session: d1ec4efa-aaf1-4457-a4ab-70059a91f1ba
1 parent 7d1536b commit 676e02f

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-runners.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To configure self-hosted runners for {% data variables.copilot.copilot_code-revi
3636
* `api.githubcopilot.com`
3737
* `uploads.github.com`
3838
* `user-images.githubusercontent.com`
39-
1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment).
39+
1. In your repository's `.github/workflows/copilot-code-review.yml` file, set the `runs-on` attribute to your ARC-managed scale set name.
4040

4141
```yaml
4242
# ...
@@ -47,6 +47,9 @@ To configure self-hosted runners for {% data variables.copilot.copilot_code-revi
4747
# ...
4848
```
4949

50+
> [!NOTE]
51+
> If your repository does not have a `copilot-code-review.yml` file, {% data variables.copilot.copilot_code-review_short %} will use the `copilot-setup-steps.yml` file instead. For more information about `copilot-setup-steps.yml`, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment).
52+
5053
## Upgrade to larger {% data variables.product.prodname_dotcom %}-hosted {% data variables.product.prodname_actions %} runners
5154

5255
By default, {% data variables.copilot.copilot_code-review_short %} runs on a standard {% data variables.product.prodname_actions %} runner. Larger runners provide better performance (CPU and memory), more disk space, and advanced features like Azure private networking. See [AUTOTITLE](/actions/concepts/runners/larger-runners).
@@ -61,7 +64,7 @@ By default, {% data variables.copilot.copilot_code-review_short %} runs on a sta
6164
* `uploads.github.com`
6265
* `user-images.githubusercontent.com`
6366

64-
1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to the label for the larger runners you want {% data variables.copilot.copilot_code-review_short %} to use. See [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/use-larger-runners).
67+
1. In your repository's `copilot-code-review.yml` file, set the `runs-on` attribute to the label for the larger runners you want {% data variables.copilot.copilot_code-review_short %} to use. See [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/use-larger-runners).
6568

6669
```yaml
6770
# ...
@@ -72,12 +75,15 @@ By default, {% data variables.copilot.copilot_code-review_short %} runs on a sta
7275
# ...
7376
```
7477

78+
> [!NOTE]
79+
> If your repository does not have a `copilot-code-review.yml` file, {% data variables.copilot.copilot_code-review_short %} will use the `copilot-setup-steps.yml` file instead.
80+
7581
## Configure runners at the organization level
7682

7783
Organization owners can set a default runner type for {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_cloud_agent %} across all repositories in the organization, and control whether individual repositories can override this default.
7884

7985
> [!NOTE]
80-
> The organization-level runner type applies to both {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_cloud_agent %}. Repositories can still override the organization default using `copilot-setup-steps.yml` unless you disable **Allow repositories to customize the runner type**. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent#preventing-repositories-from-customizing-the-runner-type).
86+
> The organization-level runner type applies to both {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_cloud_agent %}. Repositories can still override the organization default for code review using `copilot-code-review.yml` (or `copilot-setup-steps.yml`) unless you disable **Allow repositories to customize the runner type**. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent#preventing-repositories-from-customizing-the-runner-type).
8187
8288
This is useful if your organization requires all code reviews and {% data variables.copilot.copilot_cloud_agent_short %} tasks to run on specific runners, for example, to use larger runners for better performance or self-hosted runners that have access to internal resources.
8389

@@ -88,4 +94,4 @@ This is useful if your organization requires all code reviews and {% data variab
8894
1. In the "Edit runner type" dialog, select the runner type to use by default across your organization, then click **Save runner selection**.
8995
* **Standard {% data variables.product.prodname_dotcom %} runner**: {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_cloud_agent %} will use the standard {% data variables.product.prodname_dotcom %}-hosted runner.
9096
* **Labeled runner**: {% data variables.copilot.copilot_code-review_short %} and {% data variables.copilot.copilot_cloud_agent %} will use a runner matching the label you specify.
91-
1. Optionally, to prevent individual repositories from overriding the organization-level runner configuration using their `copilot-setup-steps.yml` file, disable **Allow repositories to customize the runner type**.
97+
1. Optionally, to prevent individual repositories from overriding the organization-level runner configuration using their `copilot-code-review.yml` or `copilot-setup-steps.yml` file, disable **Allow repositories to customize the runner type**.

0 commit comments

Comments
 (0)