Skip to content

Commit 2fa207a

Browse files
authored
Merge pull request #2188 from github/henrymercer/prepare-build-mode-help
Prepare `build-mode` input help
2 parents 83a02f7 + 24c3eda commit 2fa207a

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

Diff for: init/action.yml

+21-13
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,33 @@ inputs:
77
required: false
88
# If not specified the Action will check in several places until it finds the CodeQL tools.
99
languages:
10-
description: |
11-
A comma-separated value of the languages to be analysed e.g. python,javascript
10+
description: >-
11+
A comma-separated list of CodeQL languages to analyze.
12+
13+
Due to the performance benefit of parallelizing builds, we recommend specifying languages to
14+
analyze using a matrix and providing `\$\{{ matrix.language }}` as this input.
15+
16+
For more information, see
17+
https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed.
1218
required: false
1319
build-mode:
1420
description: >-
15-
[Experimental, for internal testing only] The build mode that will be used to analyze the language.
16-
This input is only available in single-language analyses.
21+
The build mode that will be used to analyze the language. This input is only available when
22+
analyzing a single CodeQL language per job, for example using a matrix.
1723
1824
Available build modes will differ based on the language being analyzed. One of:
1925
20-
- none: The database will be created without building the source code.
21-
Available for all interpreted languages and some compiled languages.
22-
- autobuild: The database will be created by attempting to automatically build the source code.
23-
To use this build mode, ensure that your workflow calls the `autobuild` action
24-
between the `init` and `analyze` steps.
25-
Available for all compiled languages.
26-
- manual: The database will be created by building the source code using a manually specified
27-
build command. To use this build mode, specify manual build steps in your workflow
28-
between the `init` and `analyze` steps. Available for all compiled languages.
26+
- `none`: The database will be created without building the source code.
27+
Available for all interpreted languages and some compiled languages.
28+
- `autobuild`: The database will be created by attempting to automatically build the source
29+
code.
30+
To use this build mode, ensure that your workflow calls the `autobuild` action
31+
between the `init` and `analyze` steps.
32+
Available for all compiled languages.
33+
- `manual`: The database will be created by building the source code using a manually
34+
specified build command. To use this build mode, specify manual build steps in
35+
your workflow between the `init` and `analyze` steps. Available for all
36+
compiled languages.
2937
required: false
3038
token:
3139
description: GitHub token to use for authenticating with this instance of GitHub. To download custom packs from multiple registries, use the registries input.

0 commit comments

Comments
 (0)