|
| 1 | +--- |
| 2 | +title: Configuring runners for GitHub Copilot cloud agent in your organization |
| 3 | +shortTitle: Configure agent runners |
| 4 | +allowTitleToDifferFromFilename: true |
| 5 | +intro: 'Configure the {% data variables.product.prodname_actions %} runners used by {% data variables.copilot.copilot_coding_agent %} and control whether repositories can customize the runner type.' |
| 6 | +permissions: Organization owners |
| 7 | +product: '{% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/github-copilot/purchase?ref_product=copilot&ref_type=trial&ref_style=button&ref_plan=enterprise" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>' |
| 8 | +versions: |
| 9 | + feature: copilot |
| 10 | +contentType: how-tos |
| 11 | +category: |
| 12 | + - Manage Copilot for a team |
| 13 | +--- |
| 14 | + |
| 15 | +## About organization-level runner controls |
| 16 | + |
| 17 | +By default, {% data variables.copilot.copilot_coding_agent %} runs on a standard {% data variables.product.prodname_dotcom %}-hosted {% data variables.product.prodname_actions %} runner (`ubuntu-latest`). As an organization owner, you can change the default runner type for all repositories in your organization, and choose whether individual repositories are allowed to override this default. |
| 18 | + |
| 19 | +This is useful if your organization requires all {% data variables.copilot.copilot_coding_agent %} sessions to run on specific runners—for example, to use larger runners for better performance, or to use self-hosted runners that have access to internal resources. |
| 20 | + |
| 21 | +You can configure: |
| 22 | + |
| 23 | +* **Runner type**: Choose between a standard {% data variables.product.prodname_dotcom %}-hosted runner or a labeled runner from a specific runner group. |
| 24 | +* **Allow repositories to customize the runner type**: Control whether repositories can override the organization default using a {% data variables.product.prodname_copilot_short %} setup steps workflow defined at `.github/workflows/copilot-setup-steps.yml`. |
| 25 | + |
| 26 | +## Configuring the default runner type |
| 27 | + |
| 28 | +{% data reusables.profile.access_org %} |
| 29 | +{% data reusables.profile.org_settings %} |
| 30 | +{% data reusables.copilot.coding-agent-settings %} |
| 31 | +1. Next to "Runner type," click the pencil icon ({% octicon "pencil" aria-label="Edit" %}). |
| 32 | +1. Select the runner type to use by default for {% data variables.copilot.copilot_coding_agent %} across your organization. |
| 33 | + * **Standard {% data variables.product.prodname_dotcom %} runner**: {% data variables.copilot.copilot_coding_agent %} will use `ubuntu-latest`. |
| 34 | + * **Labeled runner**: {% data variables.copilot.copilot_coding_agent %} will use a runner matching the group name and/or label you specify. Enter values in the **Runner group name** and/or **Runner label** fields. |
| 35 | +1. Click **Save runner selection**. |
| 36 | + |
| 37 | +## Preventing repositories from customizing the runner type |
| 38 | + |
| 39 | +By default, repositories can override the organization-level runner configuration using a {% data variables.product.prodname_copilot_short %} setup steps workflow located at `.github/workflows/copilot-setup-steps.yml`. If you want to enforce a consistent runner type across all repositories, you can disable this option. |
| 40 | + |
| 41 | +{% data reusables.profile.access_org %} |
| 42 | +{% data reusables.profile.org_settings %} |
| 43 | +{% data reusables.copilot.coding-agent-settings %} |
| 44 | +1. Under "Allow repositories to customize the runner type," toggle the setting to enable or disable repository-level customization. |
| 45 | + * When enabled, repositories can override the default runner by setting the `runs-on` field in the `copilot-setup-steps` job of `copilot-setup-steps.yml`. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment#configure-the-runner). |
| 46 | + * When disabled, all repositories in your organization will use the organization-level runner type. |
| 47 | +1. Click **Save**. |
| 48 | + |
| 49 | +## Further reading |
| 50 | + |
| 51 | +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment) |
| 52 | +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-coding-agent) |
0 commit comments