Merge pull request #23 from creative-commoners/pulls/1.1/action-permi…

…ssions DOC Document required permissions
silverstripe · May 14, 2024 · 6a579f3 · 6a579f3
2 parents 8782fc0 + 15db8e0
commit 6a579f3
Showing 1 changed file with 13 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -6,12 +6,19 @@ Create a tag and an optional release
 
 **workflow.yml**
 ```yml
-steps:
-  - name: Create tag and release
-    uses: silverstripe/gha-tag-release@v1
-    with:
-      tag: 1.2.3
-      release: true
+permissions: {}
+
+jobs:
+  tagrelease:
+    # ...
+    permissions:
+      contents: write
+    steps:
+      - name: Create tag and release
+        uses: silverstripe/gha-tag-release@v1
+        with:
+          tag: 1.2.3
+          release: true
 ```
 
 ### Inputs