mirror of
https://github.com/github/codeql-action.git
synced 2025-12-06 07:48:17 +08:00
47 lines
2.5 KiB
YAML
47 lines
2.5 KiB
YAML
name: 'Code Scanning : Upload SARIF'
|
|
description: 'Upload the analysis results'
|
|
author: 'GitHub'
|
|
inputs:
|
|
sarif_file:
|
|
description: |
|
|
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.
|
|
required: false
|
|
default: '../results'
|
|
checkout_path:
|
|
description: "The path at which the analyzed repository was checked out. Used to relativize any absolute paths in the uploaded SARIF file."
|
|
required: false
|
|
default: ${{ github.workspace }}
|
|
ref:
|
|
description: "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. Expected format: refs/heads/<branch name>, refs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head."
|
|
required: false
|
|
sha:
|
|
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 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."
|
|
required: false
|
|
default: ${{ github.token }}
|
|
matrix:
|
|
default: ${{ toJson(matrix) }}
|
|
category:
|
|
description: String used by Code Scanning for matching the analyses
|
|
required: false
|
|
wait-for-processing:
|
|
description: If true, the Action will wait for the uploaded SARIF to be processed before completing.
|
|
required: true
|
|
default: "true"
|
|
outputs:
|
|
sarif-id:
|
|
description: The ID of the uploaded Code Scanning SARIF file, if any.
|
|
sarif-ids:
|
|
description: |
|
|
A stringified JSON object containing the SARIF ID for each kind of analysis. For example:
|
|
|
|
{ "code-scanning": "some-id", "code-quality": "some-other-id" }
|
|
runs:
|
|
using: node24
|
|
main: '../lib/upload-sarif-action.js'
|
|
post: '../lib/upload-sarif-action-post.js'
|