Update README.md with content permissions information (#10)

* Update README.md with content permissions information * Make warning more noticeable... * Change to IMPORTANT
cssnr · Jan 23, 2025 · f8cb0b3 · f8cb0b3
1 parent 02be4e0
commit f8cb0b3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/.github/workflows/tags.yaml b/.github/workflows/tags.yaml
@@ -9,6 +9,8 @@ jobs:
     name: "Tags"
     runs-on: ubuntu-latest
     timeout-minutes: 5
+    permissions:
+      contents: write
 
     steps:
       - name: "Update Tags"

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -9,6 +9,8 @@ jobs:
     name: "Test"
     runs-on: ubuntu-latest
     timeout-minutes: 5
+    permissions:
+      contents: write
 
     steps:
       - name: "Checkout"

diff --git a/README.md b/README.md
@@ -54,6 +54,10 @@ delimited `|`. If you only want to update the specified `tags` make sure to set
       token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+> [!IMPORTANT]  
+> This action requires **content write permissions** to push tags.
+> See [Examples](#Examples) below for details on how to add permissions into your workflow.
+
 ## Outputs
 
 | output | description                           |
@@ -87,6 +91,8 @@ jobs:
         name: 'Tags'
         runs-on: ubuntu-latest
         timeout-minutes: 5
+        permissions:
+            contents: write
 
         steps:
             - name: 'Update Tags'