This repository is a Windows version of the myoung34/docker-github-actions-runner runner for Linux. Tried has been to keep the usage as close as possible.
This repository will run the self-hosted github actions runners for Windows with Visual Studio 2022 buildtools installed by default.
The build images can be found on Docker Hub.
| Environment Variable | Description |
|---|---|
RUNNER_NAME |
The name of the runner to use. Overrides RUNNER_NAME_PREFIX |
RUNNER_NAME_PREFIX |
A prefix for runner name. Note: will be overridden by RUNNER_NAME if provided. Defaults to windows-runner |
ACCESS_TOKEN |
A github PAT to use to generate RUNNER_TOKEN dynamically at container start. Not using this requires a valid RUNNER_TOKEN |
RUNNER_TOKEN |
If not using a PAT for ACCESS_TOKEN this will be the runner token provided by the Add Runner UI (a manual process). Note: This token is short lived and will change frequently. ACCESS_TOKEN is likely preferred. |
RUNNER_SCOPE |
The scope the runner will be registered on. Valid values are repo, org and enterprise. For 'org' and 'enterprise' the REPO_URL is unnecessary. If 'org', requires ORG_NAME; if 'enterprise', requires ENTERPRISE_NAME. Default is 'repo'. |
ORG_NAME |
The organization name for the runner to register under. Requires RUNNER_SCOPE to be 'org'. No default value. |
ENTERPRISE_NAME |
The enterprise name for the runner to register under. Requires RUNNER_SCOPE to be 'enterprise'. No default value. |
LABELS |
A comma separated string to indicate the labels. Default is 'default' |
REPO_URL |
If using a non-organization runner this is the full repository url to register under such as 'https://github.com/tiobe/repo' |
RUNNER_GROUP |
Name of the runner group to add this runner to (defaults to the default runner group) |
GITHUB_HOST |
Optional URL of the Github Enterprise server e.g github.mycompany.com. Defaults to github.com. |
DISABLE_AUTO_UPDATE |
Optional environment variable to disable auto updates. Auto updates are enabled by default to preserve past behavior. Any value is considered truthy and will disable them. |