Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 6.26 KB

configuring-larger-runners-for-default-setup.md

File metadata and controls

52 lines (40 loc) · 6.26 KB
Raw
title shortTitle intro product permissions versions topics
Configuring larger runners for default setup
Configure larger runners
You can run {% data variables.product.prodname_code_scanning %} default setup more quickly on bigger codebases using {% data variables.actions.hosted_runners %}.
{% data reusables.gated-features.code-scanning %}
{% data reusables.actions.larger-runner-permissions %}
feature
default-setup-larger-runners
Code scanning
CodeQL
Actions

{% data reusables.code-scanning.beta-larger-runners-support %}

About {% data variables.actions.hosted_runners %} for default setup

{% data reusables.actions.about-larger-runners %} For more information about {% data variables.actions.hosted_runners %}, see "AUTOTITLE."

Consider configuring {% data variables.actions.hosted_runners %} for default setup if:

  • Your scans with standard {% data variables.product.prodname_dotcom %}-hosted runners are taking too long.
  • Your scans with standard {% data variables.product.prodname_dotcom %}-hosted runners are returning memory or disk errors.
  • You want to customize aspects of your {% data variables.product.prodname_code_scanning %} runner like the runner size, runner image, and job concurrency without using self-hosted runners.

{% warning %}

Warning: Currently, Swift analysis is not available on {% data variables.actions.hosted_runners %} for default setup. Additionally, if your repository has access to a runner with the code-scanning label, such as a {% data variables.actions.hosted_runner %} provisioned for default setup, default setup workflows will only use runners labeled code-scanning. If you would like to configure default setup on {% data variables.actions.hosted_runners %} and analyze Swift, you have two options:

  • Provision a self-hosted macOS runner with the code-scanning label in addition to your {% data variables.actions.hosted_runner %}. For more information, see {% ifversion ghec %}"AUTOTITLE."{% else %}"AUTOTITLE."{% endif %}
  • Ensure any repositories containing Swift do not have access to runners with the label code-scanning. Default setup workflows for that repository will only use standard runners.

{% endwarning %}

{% ifversion ghec %}

Provisioning enterprise-level {% data variables.actions.hosted_runners %} for default setup

  1. Add a {% data variables.actions.hosted_runner %} to your enterprise. For more information, see "AUTOTITLE."
    • To add the code-scanning label to your {% data variables.actions.hosted_runner %}, name the runner code-scanning. An enterprise can only have one {% data variables.actions.hosted_runner %} named code-scanning, and that runner will handle all {% data variables.product.prodname_code_scanning %} jobs for all organizations and repositories within your enterprise that:
      • Have access to the enterprise-level runner, and
      • Don't have access to an organization-level {% data variables.actions.hosted_runner %} named code-scanning. If an organization or repository also has access to an organization-level {% data variables.actions.hosted_runner %} named code-scanning, each {% data variables.product.prodname_code_scanning %} job will be randomly assigned to either the organization-level or enterprise-level runner. {% data reusables.actions.org-access-to-github-hosted-runners %}
  2. To analyze repositories with default setup, grant the desired repositories access to the runner group your {% data variables.actions.hosted_runner %} is assigned to. For more information, see "AUTOTITLE."
  3. You can now configure default setup for your enterprise, organizations, and repositories, and your {% data variables.actions.hosted_runner %} will automatically pick up {% data variables.product.prodname_code_scanning %} jobs as previously specified. For more information on configuring default setup, see "AUTOTITLE" and "AUTOTITLE." {% endif %}

Provisioning organization-level {% data variables.actions.hosted_runners %} for default setup

  1. Add a {% data variables.actions.hosted_runner %} to your organization. For more information, see "AUTOTITLE."
    • To add the code-scanning label to your {% data variables.actions.hosted_runner %}, name the runner code-scanning. An organization can only have one {% data variables.actions.hosted_runner %} with the code-scanning label, and that runner will handle all {% data variables.product.prodname_code_scanning %} jobs from repositories within your organization with access to the runner's group.
  2. By default, all repositories in your organization have access to organization-level runners, meaning every repository can use your {% data variables.actions.hosted_runner %}. For information on granting only select repositories access to a {% data variables.actions.hosted_runner %}, see "AUTOTITLE."
  3. You can now configure default setup for your organization and repositories, and your {% data variables.actions.hosted_runner %} will automatically pick up {% data variables.product.prodname_code_scanning %} jobs. For more information on configuring default setup, see "AUTOTITLE" and "AUTOTITLE."