GitHub allows developers to run GitHub Actions workflows on one own runners. This Docker image is intended to be used as locally hosted runner for the ibis-hdl project. This is based on myoung34's Docker Github Actions Runner.
Optionally, you can create a .env to provide environment variables when using docker-compose, e.g.:
GH_REPO_URL=https://github.com/ibis-hdl/compiler
GH_RUNNER_NAME="localhost"
GH_RUNNER_LABELS="compiler"
GH_RUNNER_WORKDIR=/home/runner/work
It's not mandatory since the docker-compose.yml holds predefined values, intentionally project related.
In order to link your runner to repository, an ACCESS_TOKEN containing a Personal Access Token (PAT) is required. This token will be used to dynamically fetch a new runner token, as runner tokens are valid for a short period of time (1 hour) only.
To prevent accidental publication of the PAT the secret is stored in a separate secrets.txt file:
ACCESS_TOKEN=<PAT goes here>
and excluded from publishing by use of .gitignore and .dockerignore.