Skip to content

Commit 6182f33

Browse files
committed
Add documentation for the tools option in the various workflow files
1 parent 4995c49 commit 6182f33

File tree

3 files changed

+27
-4
lines changed

3 files changed

+27
-4
lines changed

.github/actions/check-codescanning-config/action.yml

+9-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,15 @@ inputs:
2929
tools:
3030
required: true
3131
description: |
32-
The url of codeql to use.
32+
The version of the CodeQL tools to use. This can be any of the following:
33+
34+
- A local path to a tarball containing the CodeQL tools, or
35+
- A URL to a GitHub release assets containing the CodeQL tools, or
36+
- A special value `linked` which is forcing the use of the CodeQL tools
37+
that the action has been bundled with.
38+
39+
If not specified, the Action will check in several places until it finds
40+
the CodeQL tools.
3341
3442
runs:
3543
using: composite

.github/actions/query-filter-test/action.yml

+9-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,15 @@ inputs:
2323
tools:
2424
required: true
2525
description: |
26-
The url of codeql to use.
26+
The version of the CodeQL tools to use. This can be any of the following:
27+
28+
- A local path to a tarball containing the CodeQL tools, or
29+
- A URL to a GitHub release assets containing the CodeQL tools, or
30+
- A special value `linked` which is forcing the use of the CodeQL tools
31+
that the action has been bundled with.
32+
33+
If not specified, the Action will check in several places until it finds
34+
the CodeQL tools.
2735
2836
runs:
2937
using: composite

init/action.yml

+9-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@ description: 'Set up CodeQL'
33
author: 'GitHub'
44
inputs:
55
tools:
6-
description: URL of CodeQL tools
6+
description: >-
7+
The version of the CodeQL tools to use. This can be any of the following:
8+
9+
- A local path to a tarball containing the CodeQL tools, or
10+
- A URL to a GitHub release assets containing the CodeQL tools, or
11+
- A special value `linked` which is forcing the use of the CodeQL tools
12+
that the action has been bundled with.
13+
14+
If not specified, the Action will check in several places until it finds the CodeQL tools.
715
required: false
8-
# If not specified the Action will check in several places until it finds the CodeQL tools.
916
languages:
1017
description: >-
1118
A comma-separated list of CodeQL languages to analyze.

0 commit comments

Comments
 (0)