Fix incorrect documentation about the token input to the Actions.

github · Sep 13, 2024 · d795ead · d795ead
1 parent 4a01ec7
commit d795ead
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/analyze/action.yml b/analyze/action.yml
@@ -74,7 +74,7 @@ inputs:
     required: true
     default: "true"
   token:
-    description: "GitHub token to use for authenticating with this instance of GitHub. The token needs the `security-events: write` permission."
+    description: "GitHub token to use for authenticating with this instance of GitHub. The token must be the built-in GitHub Actions token, and the workflow should have the `security-events: write` permission."
     required: false
     default: ${{ github.token }}
   matrix:

diff --git a/upload-sarif/action.yml b/upload-sarif/action.yml
@@ -20,7 +20,7 @@ inputs:
     description: "The sha of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable. If provided, the ref input must be provided as well. This input is ignored for pull requests from forks."
     required: false
   token:
-    description: "GitHub token to use for authenticating with this instance of GitHub. The token needs the `security-events: write` permission."
+    description: "GitHub token to use for authenticating with this instance of GitHub. The token must be the built-in GitHub Actions token, and the workflow should have the `security-events: write` permission."
     required: false
     default: ${{ github.token }}
   matrix: