Skip to content

Commit

Permalink
docs(readme): update the permissions docs to reflect the requirements…
Browse files Browse the repository at this point in the history
… of the default config (#512)

Fixes #511
  • Loading branch information
C0ZEN committed Jun 24, 2021
1 parent d3bfc50 commit 678bfc7
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions README.md
Expand Up @@ -11,24 +11,17 @@ 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:
issues: write
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
Expand Down

0 comments on commit 678bfc7

Please sign in to comment.