5 Commits

Author SHA1 Message Date
Steve-Glass efa922e8dd Merge pull request #70 from actions/update-readme-with-multi-label
Clarify scale set registration process
2026-02-05 07:50:38 -05:00
Steve-Glass ff25a89ba7 Clarify scale set registration process
Added clarification that multiple labels can be assigned per scale set.
2026-02-05 07:42:45 -05:00
Nikola Jokic 2f9b84ee5a Fix status in readme (#69) 2026-02-05 11:48:08 +00:00
Francesco Renzi 63a0a32683 It's alive! (#68)
Updated README to reflect the change from Private Preview to Public Preview status.
2026-02-05 09:52:53 +01:00
Francesco Renzi e4a017ce06 Initial commit for open source release 🚀
Co-authored-by: Francesco Renzi <rentziass@github.com>
Co-authored-by: Nikola Jokic <jokicnikola07@gmail.com>
2026-02-03 16:41:15 +01:00
+3 -3
View File
@@ -1,6 +1,6 @@
# GitHub Actions Runner Scale Set Client (Private Preview)
# GitHub Actions Runner Scale Set Client (Public Preview)
> Status: **Private Preview** While the API is stable, interfaces and examples in this repository may change.
> Status: **Public Preview** While the API is stable, interfaces and examples in this repository may change.
This repository provides a standalone Go client for the GitHub Actions **Runner Scale Set** APIs. It is extracted from the `actions-runner-controller` project so that platform teams, integrators, and infrastructure providers can build **their own custom autoscaling solutions** for GitHub Actions runners.
@@ -12,7 +12,7 @@ You do *not* need to adopt the full controller (and Kubernetes) to take advantag
A runner scale set is a group of self-hosted runners that autoscales based on workflow demand. Here's how it works:
1. **Registration**: You create a scale set with a name, which also serves as the label workflows use to target it (e.g., `runs-on: my-scale-set`). Like regular self-hosted runners, scale sets can be registered at the repository, organization, or enterprise level.
1. **Registration**: You create a scale set with a name, which also serves as the label workflows use to target it (e.g., `runs-on: my-scale-set`). Multiple labels can be assigned per scale set. Like regular self-hosted runners, scale sets can be registered at the repository, organization, or enterprise level.
2. **Polling**: Your scale set client continuously polls the API, reporting its maximum capacity (how many runners it can produce).
3. **Job matching**: GitHub matches jobs to your scale set based on the label and runner group policies, just like regular self-hosted runners.
4. **Scaling signal**: The API responds with how many runners your scale set needs online (`statistics.TotalAssignedJobs`).