check-spelling-sandbox/Code Scanning : Upload SARIF
Upload the analysis results
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| sarif_file | The SARIF file or directory of SARIF files to be uploaded to GitHub code scanning. See https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions for information on the maximum number of results and maximum file size supported by code scanning. | no | ../results |
| checkout_path | The path at which the analyzed repository was checked out. Used to relativize any absolute paths in the uploaded SARIF file. | no | ${{ github.workspace }} |
| ref | The ref where results will be uploaded. If not provided, the Action will use the GITHUB_REF environment variable. If provided, the sha input must be provided as well. This input is ignored for pull requests from forks. | no | — |
| sha | 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. | no | — |
| token | GitHub token to use for authenticating with this instance of GitHub. The token must be the built-in GitHub Actions token, and the workflow must have the `security-events: write` permission. Most of the time it is advisable to avoid specifying this input so that the workflow falls back to using the default value. | no | ${{ github.token }} |
| matrix | — | — | ${{ toJson(matrix) }} |
| category | String used by Code Scanning for matching the analyses | no | — |
| wait-for-processing | If true, the Action will wait for the uploaded SARIF to be processed before completing. | yes | true |
Outputs
| name | description |
|---|---|
| sarif-id | The ID of the uploaded SARIF file. |