Skip to content

Commit

Permalink
docs(readme): add missing permission for delete-branch option in read…
Browse files Browse the repository at this point in the history
…me (#796)
  • Loading branch information
dan-pavlov authored Sep 7, 2022
1 parent 48bae59 commit 65afee9
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ The configuration must be on the default branch and the default values will:
## Recommended permissions

For the execution of this action, it must be able to fetch all issues and pull requests from your repository.
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, delete branch, etc.).
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:
contents: write # only for delete-branch option
issues: write
pull-requests: write
```
Expand Down Expand Up @@ -396,7 +397,7 @@ Default value: unset
If set to `true`, the stale workflow will automatically delete the GitHub branches related to the pull requests automatically closed by the stale workflow.

Default value: `false`
Required Permission: `pull-requests: write`
Required Permission: `pull-requests: write` and `contents: write`

#### exempt-milestones

Expand Down

1 comment on commit 65afee9

@sheldonhull
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for making sure permissions were explicitly declared. I'm reviewing updates and this is appreciated! 🙏🏻

Please sign in to comment.