Apply documentation suggestions from code review

Co-authored-by: Andrew Eisenberg <aeisenberg@github.com>
This commit is contained in:
cw-acroteau
2022-01-25 18:06:35 -05:00
committed by Alex Croteau
parent 980fd4ed38
commit 0dd4dbf9d9
3 changed files with 6 additions and 4 deletions

View File

@@ -46,10 +46,10 @@ inputs:
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."
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."
required: false
sha:
description: "The hash of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable."
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."
required: false
category:
description: String used by Code Scanning for matching the analyses
@@ -70,7 +70,7 @@ outputs:
db-locations:
description: A map from language to absolute path for each database created by CodeQL.
sarif-id:
description: The ID of the uploaded sarif file.
description: The ID of the uploaded SARIF file.
runs:
using: "node12"
main: "../lib/analyze-action.js"