Skip to content

Commit a69c7cb

Browse files
mbgmbg
committed
Document that setting the env vars to false takes precedence
1 parent 74ddcd9 commit a69c7cb

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

‎src/environment.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,12 +169,17 @@ export enum EnvVar {
169169
* Whether to skip generating a failed SARIF file. Intended for testing purposes.
170170
* This setting is more specific than `CODEQL_ACTION_TEST_MODE` and
171171
* `CODEQL_ACTION_SKIP_SARIF_UPLOAD`, which imply this option.
172+
*
173+
* Setting this to `false` takes precedence over `CODEQL_ACTION_TEST_MODE: true` or
174+
* `CODEQL_ACTION_SKIP_SARIF_UPLOAD: true`.
172175
*/
173176
SKIP_GENERATE_FAILED_SARIF = "CODEQL_ACTION_SKIP_GENERATE_FAILED_SARIF",
174177

175178
/**
176179
* Whether to skip uploading SARIF results to GitHub. Intended for testing purposes.
177180
* This setting is more specific than `CODEQL_ACTION_TEST_MODE`, which implies this option.
181+
*
182+
* Setting this to `false` takes precedence over `CODEQL_ACTION_TEST_MODE: true`.
178183
*/
179184
SKIP_SARIF_UPLOAD = "CODEQL_ACTION_SKIP_SARIF_UPLOAD",
180185

0 commit comments

Comments
 (0)