Document required permissions (#38)

fgrosse · Jul 25, 2024 · 89095d9 · 89095d9
1 parent 01ee5ff
commit 89095d9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 - Fix issue with code coverage information missing when test files are deleted (fgrosse/go-coverage-report#35)
+- Document permissions needed to use this action (fgrosse/go-coverage-report#32)
 
 ## [v1.0.2] - 2024-06-11
 - Fix issue when coverage artifact contains more files than just the `coverage.txt` file (fgrosse/go-coverage-report#25)

diff --git a/README.md b/README.md
@@ -96,6 +96,9 @@ jobs:
     if: github.event_name == 'pull_request' # Do not run when workflow is triggered by push to main branch
     runs-on: ubuntu-latest
     needs: unit_tests # Depends on the artifact uploaded by the "unit_tests" job
+    permissions:
+      contents:      read  # to download code coverage results from unit_tests job
+      pull-requests: write # write permission needed to comment on PR
     steps:
       - uses: fgrosse/go-coverage-report@v1.0.2 # Consider using a Git revision for maximum security
         with: