From 65afee970e2c4b4951c3632ff902aa0c4172f4ef Mon Sep 17 00:00:00 2001 From: Dan Pavlov <15880892+dan-pavlov@users.noreply.github.com> Date: Wed, 7 Sep 2022 16:16:55 +0100 Subject: [PATCH] docs(readme): add missing permission for delete-branch option in readme (#796) --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ab50de3..8a65a5a1 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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