Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kenmuse authored Aug 27, 2024
1 parent 9561fac commit c8b28ce
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## About

This provides a sample implementation of a containerized Windows-based Actions runner for [GitHub Actions Runner Controller](https://github.com/actions/actions-runner-controller). The build process for the image uses the latest version of the [Actions Runner](https://github.com/actions/runner), assigning a `latest` tag and a tag for the runner version. Runner images should be rebuild daily using a scheduled task to ensure that images are never more than 24 hours behind the current versions. Runners must be updated [at least every 30 days](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners).
This provides a sample implementation of a containerized Windows-based Actions runner for [GitHub Actions Runner Controller](https://github.com/actions/actions-runner-controller). The build process for the image uses the latest version of the [Actions Runner](https://github.com/actions/runner), assigning a `latest` tag and a tag for the runner version. Runner images should ideally be rebuilt daily using a scheduled task to ensure that images are never more than 24 hours behind the current versions. Runners should be updated [at least every 30 days](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners) to avoid the risk of the runner not being able to accept jobs.

There are some additional notes included in the [Dockerfile](./Dockerfile) about the image and the steps for creating that image. Be aware that Windows containers behave very differently from Linux containers (both in level of API support and performance). I recommend considering a GitHub hosted runner for Windows builds whenever possible to have faster build times and access to the broader OS APIs and features.

## Support

Expand Down

0 comments on commit c8b28ce

Please sign in to comment.