From 678bfc7a5922eeb440317b84cc7d119dd4504244 Mon Sep 17 00:00:00 2001 From: Geoffrey Testelin Date: Thu, 24 Jun 2021 22:30:27 +0200 Subject: [PATCH] docs(readme): update the permissions docs to reflect the requirements of the default config (#512) Fixes #511 --- README.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6f590e34..833af3ef 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,8 @@ The default configuration will: ## Recommended permissions For the execution of this action, it must be able to fetch all issues and pull requests from your repository. -This can be achieved with the following [configuration in the action](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions) if the permissions are restricted: - -```yaml -permissions: - issues: read - pull-requests: read -``` - In addition, based on the provided configuration, the action could require more permission(s) (e.g.: add label, remove label, comment, close, etc.). -You can find more information about the required permissions under the corresponding options that you wish to use. -However, if don't want to bother, you can use these permissions: +This can be achieved with the following [configuration in the action](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions) if the permissions are restricted: ```yaml permissions: @@ -29,6 +20,8 @@ permissions: pull-requests: write ``` +You can find more information about the required permissions under the corresponding options that you wish to use. + ## All options ### List of input options