Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(readme): add missing permission for delete-branch option in readme #796

Merged
merged 1 commit into from Sep 7, 2022
Merged

docs(readme): add missing permission for delete-branch option in readme #796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
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