Using ARC runners in a workflow file

To assign jobs to run on a runner scale set, you can specify the name of the scale set as the value for theruns-on key in your GitHub Actions workflow file.

For example, the following configuration for a runner scale set has theINSTALLATION_NAME value set toarc-runner-set.

# Using a Personal Access Token (PAT)INSTALLATION_NAME="arc-runner-set"NAMESPACE="arc-runners"GITHUB_CONFIG_URL="https://github.com/<your_enterprise/org/repo>"GITHUB_PAT="<PAT>"helm install"${INSTALLATION_NAME}" \    --namespace"${NAMESPACE}" \    --create-namespace \    --set githubConfigUrl="${GITHUB_CONFIG_URL}" \    --set githubConfigSecret.github_token="${GITHUB_PAT}" \    oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set

To use this configuration in a workflow, set the value of theruns-on key in your workflow toarc-runner-set, similar to the following example.

jobs:job_name:runs-on:arc-runner-set

Using runner scale set names

Runner scale set names are unique within the runner group they belong to. To deploy multiple runner scale sets with the same name, they must belong to different runner groups. For more information about specifying runner scale set names, seeDeploying runner scale sets with Actions Runner Controller.

You cannot use additional labels to target runners created by ARC. You can only use the installation name of the runner scale set that you specified during the installation or by defining the value of therunnerScaleSetName field in yourvalues.yaml file. These are used as the 'single label' to use as yourruns-on target. For more information, seeDeploying runner scale sets with Actions Runner Controller.

Legal notice

Portions have been adapted fromhttps://github.com/actions/actions-runner-controller/ under the Apache-2.0 license:

Copyright 2019 Moto IshizawaLicensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at    http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.