docs(README): add permissions to examples

The action requires specific permissions for the GITHUB_TOKEN. Simply adding them to the examples should be clear enough for most users.
korthout · Dec 24, 2021 · 8fdd495 · 8fdd495
1 parent 791c35e
commit 8fdd495
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,9 @@ jobs:
   build:
     name: Create backport PRs
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # so it can comment
+      pull-requests: write # so it can create pull requests
     # Don't run on closed unmerged pull requests
     if: github.event.pull_request.merged
     steps:
@@ -91,6 +94,9 @@ jobs:
   build:
     name: Create backport PRs
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # so it can comment
+      pull-requests: write # so it can create pull requests
     # Only run when pull request is merged
     # or when a comment containing `/backport` is created
     if: >