From 955f242e7071d229505dd25bbc089bf5144b31f9 Mon Sep 17 00:00:00 2001 From: Thomas Stringer Date: Sun, 6 Nov 2022 08:12:10 -0500 Subject: [PATCH] Add documentation for required permissions (#57) Signed-off-by: Thomas Stringer --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index e64c259..96674cf 100644 --- a/README.md +++ b/README.md @@ -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).