| services.github-runners.<name>.name | Name of the runner to configure
|
| services.github-runners.<name>.user | User under which to run the service
|
| services.github-runners.<name>.group | Group under which to run the service
|
| services.github-runners.<name>.package | The github-runner package to use.
|
| services.github-runners.<name>.workDir | Working directory, available as $GITHUB_WORKSPACE during workflow runs
and used as a default for repository checkouts
|
| services.github-runners.<name>.replace | Replace any existing runner with the same name
|
| services.github-runners.<name>.enable | Whether to enable GitHub Actions runner
|
| services.github-runners.<name>.url | Repository to add the runner to
|
| services.github-runners.<name>.extraLabels | Extra labels in addition to the default (unless disabled through the noDefaultLabels option)
|
| services.github-runners.<name>.runnerGroup | Name of the runner group to add this runner to (defaults to the default runner group)
|
| services.github-runners.<name>.nodeRuntimes | List of Node.js runtimes the runner should support.
|
| services.github-runners.<name>.extraPackages | Extra packages to add to PATH of the service to make them available to workflows.
|
| services.github-runners.<name>.noDefaultLabels | Disables adding the default labels
|
| services.github-runners.<name>.serviceOverrides | Modify the service
|
| services.github-runners.<name>.extraEnvironment | Extra environment variables to set for the runner, as an attrset.
|
| services.github-runners.<name>.ephemeral | If enabled, causes the following behavior:
- Passes the
--ephemeral flag to the runner configuration script
- De-registers and stops the runner with GitHub after it has processed one job
- Restarts the service after its successful exit
- On start, wipes the state directory and configures a new runner
You should only enable this option if tokenFile points to a file which contains a
personal access token (PAT)
|
| services.github-runners.<name>.tokenFile | The full path to a file which contains either
- a fine-grained personal access token (PAT),
- a classic PAT
- or a runner registration token
Changing this option or the tokenFile’s content triggers a new runner registration
|