From c4148acf4c0fc2e016ef4b25c7cb67b4290fc50d Mon Sep 17 00:00:00 2001
From: Steve Boyd <emteknetnz@gmail.com>
Date: Tue, 16 Apr 2024 18:47:13 +1200
Subject: [PATCH] DOC Document required permissions

---
 README.md | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 90a05aa..14c8ad7 100644
--- a/README.md
+++ b/README.md
@@ -8,11 +8,20 @@ This action is intended as a step in a larger workflow and at a minimum the repo
 
 **workflow.yml**
 ```yml
-steps:
-  - name: Create pull-request
-    uses: silverstripe/gha-pull-request@v1
-    with:
-      branch: pulls/4/my-branch
-      title: NEW My pull-request title
-      description: (Optional) This text will appear in the body of the GitHub pull-request
+permissions: {}
+
+jobs:
+  pullrequest:
+    # ...
+    permissions:
+      contents: write
+      pull-request: write
+      actions: write
+    steps:
+      - name: Create pull-request
+        uses: silverstripe/gha-pull-request@v1
+        with:
+          branch: pulls/4/my-branch
+          title: NEW My pull-request title
+          description: (Optional) This text will appear in the body of the GitHub pull-request
 ```