actions
/
stale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): update the permissions docs to reflect the requirements of the default config (#512) 

Fixes #511
This commit is contained in:
Geoffrey Testelin 2021-06-24 22:30:27 +02:00 committed by GitHub
parent d3bfc50685
commit 678bfc7a59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -11,17 +11,8 @@ The default configuration will:
## Recommended permissions ## Recommended permissions
For the execution of this action, it must be able to fetch all issues and pull requests from your repository. 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.). 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. 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:
However, if don't want to bother, you can use these permissions:
```yaml ```yaml
permissions: permissions:
@ -29,6 +20,8 @@ permissions:
pull-requests: write pull-requests: write
``` ```
You can find more information about the required permissions under the corresponding options that you wish to use.
## All options ## All options
### List of input options ### List of input options