From 3446d4d761fc87f7099561fd98d6141ef46f7dd4 Mon Sep 17 00:00:00 2001 From: Callum Tait Date: Fri, 13 Nov 2020 08:27:18 +0000 Subject: [PATCH] docs: reordering to be more logical --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fbcb9ffc..f33de430 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,12 @@ There are two ways for actions-runner-controller to authenticate with the GitHub 1. Using GitHub App. 2. Using Personal Access Token. +Regardless of which authentication method you use, the same permissions are required, those permissions are: +- Repository: Administration (read/write) +- Repository: Actions (read) +- Organization: Self-hosted runners (read/write) + + **NOTE: It is extremely important to only follow one of the sections below and not both.** ### Using GitHub App @@ -76,11 +82,6 @@ $ kubectl create secret generic controller-manager \ --from-file=github_app_private_key=${PRIVATE_KEY_FILE_PATH} ``` -The permissions required are: -- Repository: Administration (read/write) -- Repository: Actions (read) -- Organization: Self-hosted runners (read/write) - ### Using Personal Access Token From an account that has `admin` privileges for the repository, create a [personal access token](https://github.com/settings/tokens) with `repo` scope. This token is used to register a self-hosted runner by *actions-runner-controller*.