Add documentation for the tools option in the various workflow files
This commit is contained in:
parent
4995c49010
commit
6182f337aa
3 changed files with 27 additions and 4 deletions
|
|
@ -29,7 +29,15 @@ inputs:
|
||||||
tools:
|
tools:
|
||||||
required: true
|
required: true
|
||||||
description: |
|
description: |
|
||||||
The url of codeql to use.
|
The version of the CodeQL tools to use. This can be any of the following:
|
||||||
|
|
||||||
|
- A local path to a tarball containing the CodeQL tools, or
|
||||||
|
- A URL to a GitHub release assets containing the CodeQL tools, or
|
||||||
|
- A special value `linked` which is forcing the use of the CodeQL tools
|
||||||
|
that the action has been bundled with.
|
||||||
|
|
||||||
|
If not specified, the Action will check in several places until it finds
|
||||||
|
the CodeQL tools.
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: composite
|
using: composite
|
||||||
|
|
|
||||||
10
.github/actions/query-filter-test/action.yml
vendored
10
.github/actions/query-filter-test/action.yml
vendored
|
|
@ -23,7 +23,15 @@ inputs:
|
||||||
tools:
|
tools:
|
||||||
required: true
|
required: true
|
||||||
description: |
|
description: |
|
||||||
The url of codeql to use.
|
The version of the CodeQL tools to use. This can be any of the following:
|
||||||
|
|
||||||
|
- A local path to a tarball containing the CodeQL tools, or
|
||||||
|
- A URL to a GitHub release assets containing the CodeQL tools, or
|
||||||
|
- A special value `linked` which is forcing the use of the CodeQL tools
|
||||||
|
that the action has been bundled with.
|
||||||
|
|
||||||
|
If not specified, the Action will check in several places until it finds
|
||||||
|
the CodeQL tools.
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: composite
|
using: composite
|
||||||
|
|
|
||||||
|
|
@ -3,9 +3,16 @@ description: 'Set up CodeQL'
|
||||||
author: 'GitHub'
|
author: 'GitHub'
|
||||||
inputs:
|
inputs:
|
||||||
tools:
|
tools:
|
||||||
description: URL of CodeQL tools
|
description: >-
|
||||||
|
The version of the CodeQL tools to use. This can be any of the following:
|
||||||
|
|
||||||
|
- A local path to a tarball containing the CodeQL tools, or
|
||||||
|
- A URL to a GitHub release assets containing the CodeQL tools, or
|
||||||
|
- A special value `linked` which is forcing the use of the CodeQL tools
|
||||||
|
that the action has been bundled with.
|
||||||
|
|
||||||
|
If not specified, the Action will check in several places until it finds the CodeQL tools.
|
||||||
required: false
|
required: false
|
||||||
# If not specified the Action will check in several places until it finds the CodeQL tools.
|
|
||||||
languages:
|
languages:
|
||||||
description: >-
|
description: >-
|
||||||
A comma-separated list of CodeQL languages to analyze.
|
A comma-separated list of CodeQL languages to analyze.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue