Add documentation for required permissions (#57)

Signed-off-by: Thomas Stringer <thomas@trstringer.com>
This commit is contained in:
Thomas Stringer 2022-11-06 08:12:10 -05:00 committed by GitHub
parent 984d11212e
commit 955f242e70
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -76,6 +76,17 @@ steps:
...
```
## Permissions
For the action to create a new issue in your project, please ensure that the action has write permissions on issues. You may have to add the following to your workflow:
```yaml
permissions:
issues: write
```
For more information on permissions, please look at the [GitHub documentation](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs).
## Limitations
* While the workflow is paused, it will still continue to consume a concurrent job allocation out of the [max concurrent jobs](https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#usage-limits).