From c69c8dd84da692b8cbdac4a7d71fd2287a9c6dc5 Mon Sep 17 00:00:00 2001 From: Callum Tait <15716903+toast-gear@users.noreply.github.com> Date: Tue, 1 Mar 2022 08:54:24 +0000 Subject: [PATCH] docs: better runner group description --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 69606a70..8f9a4b71 100644 --- a/README.md +++ b/README.md @@ -1073,8 +1073,7 @@ spec: GitHub supports custom visilibity in a Runner Group to make it available to a specific set of repositories only. By default if no GitHub authentication is included in the GitHub webhook server it will be assumed that all runner groups to be usable in all repositories. -Supporting custom visibility requires to do a few GitHub API calls to find out what are the potential runner groups that are visible to -the webhook's repository, this may incur in increased API rate limiting when using github.com +Currently, GitHub do not include the repository runner group membership information in the workflow_job event (or any webhook). To make the controller "runner group aware" additional GitHub API calls are needed to find out what runner groups are visible to the webhook's repository. This behaviour will impact your rate-limit budget and so the option needs to be explicitly configured by the end user. This option will be enabled when proper GitHub authentication options (token, app or basic auth is provided) in the GitHub webhook server and `useRunnerGroupsVisibility` is set to true, e.g.