DOC Document required permissions

silverstripe · Apr 16, 2024 · 0fbbcac · 0fbbcac
1 parent b87ebd6
commit 0fbbcac
Showing 1 changed file with 17 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -6,16 +6,21 @@ Create a new issue using a github-actions user as the author. These will be crea
 
 **workflow.yml**
 ```yml
-steps:
-  - name: Create issue
-    uses: silverstripe/gha-issue@v1
-    with:
-      title: My issue title
-      description: |
-        This text will appear in the body of the GitHub issue\n
-        \n
-        You can add line breaks\n
-        \n
-        ## My heading\n
-        - Markdown is supported\n
+job:
+  # ...
+  permissions:
+    issue: write
+  # ...
+  steps:
+    - name: Create issue
+      uses: silverstripe/gha-issue@v1
+      with:
+        title: My issue title
+        description: |
+          This text will appear in the body of the GitHub issue\n
+          \n
+          You can add line breaks\n
+          \n
+          ## My heading\n
+          - Markdown is supported\n
 ```