From b87e6e3966d1c8d2c0995b452949c9061e020046 Mon Sep 17 00:00:00 2001 From: Yusuke Kuoka Date: Tue, 9 Nov 2021 09:12:47 +0900 Subject: [PATCH] doc: Add GitHub App Permission for Workflow Job Webhook (#932) * doc: Add GitHub App Permission for Workflow Job Webhook I think we've missed documenting about the app permission for receiving workflow_job events via the app webhook * docs: clarification on webhook events Co-authored-by: Callum Tait <15716903+toast-gear@users.noreply.github.com> --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ba073807..7461668a 100644 --- a/README.md +++ b/README.md @@ -114,11 +114,15 @@ _Note: Links are provided further down to create an app for your logged in user **Organization Permissions** * Self-hosted runners (read / write) -**Subscribe to events** -* Check run (if you are going to use [Webhook Driven Scaling](#webhook-driven-scaling)) - _Note: All API routes mapped to their permissions can be found [here](https://docs.github.com/en/rest/reference/permissions-required-for-github-apps) if you wish to review_ +**Subscribe to events** + +At this point you have a choice of configuring a webhook, a webhook is needed if you are going to use [webhook driven scaling](#webhook-driven-scaling). The webhook can be configured centrally in the GitHub app itself or separately. In either case the event details are: + +* Check run (required for all webhook driven scaling events) +* Workflow job (optionally) (required for [webhook driven scaling with workflow_job events](https://github.com/actions-runner-controller/actions-runner-controller#example-1-scale-on-each-workflow_job-event) + --- **Setup Steps**