From e0b9da7b0a10d6ed880ead85f0d223ed1e631bc8 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Mon, 6 Oct 2025 14:38:32 +0200 Subject: [PATCH 1/9] Introduce `CODEQL_ACTION_SKIP_SARIF_UPLOAD` This triggers a subset of the behavior of `CODEQL_ACTION_TEST_MODE`, specifically just skipping the SARIF upload step. This is required for our internal testing where we want the SARIF file (via `CODEQL_ACTION_DUMP_SARIF_DIR`) but don't want to actually upload it, but we don't want the rest of the behaviour of `CODEQL_ACTION_TEST_MODE` that is specific for `codeql-action` own CI checks. --- lib/analyze-action.js | 11 ++++++----- lib/init-action-post.js | 13 +++++++------ lib/upload-lib.js | 11 ++++++----- lib/upload-sarif-action.js | 15 ++++++++------- src/environment.ts | 6 ++++++ src/init-action-post-helper.ts | 4 ++-- src/upload-lib.ts | 10 ++++------ src/upload-sarif-action.ts | 6 +++--- src/util.ts | 9 ++++++++- 9 files changed, 50 insertions(+), 35 deletions(-) diff --git a/lib/analyze-action.js b/lib/analyze-action.js index c2788900b3..18725b2fa8 100644 --- a/lib/analyze-action.js +++ b/lib/analyze-action.js @@ -89773,6 +89773,9 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +} function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; if (testingEnvironment === "") { @@ -95532,17 +95535,15 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (isInTestMode()) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path18.join( getTemporaryDirectory(), "payload.json" ); - logger.info( - `In test mode. Results are not uploaded. Saving to ${payloadSaveFile}` - ); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs18.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); - return "test-mode-sarif-id"; + return "dummy-sarif-id"; } const client = getApiClient(); try { diff --git a/lib/init-action-post.js b/lib/init-action-post.js index e138420a3e..71c2588094 100644 --- a/lib/init-action-post.js +++ b/lib/init-action-post.js @@ -128072,6 +128072,9 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +} function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; if (testingEnvironment === "") { @@ -133008,17 +133011,15 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (isInTestMode()) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path17.join( getTemporaryDirectory(), "payload.json" ); - logger.info( - `In test mode. Results are not uploaded. Saving to ${payloadSaveFile}` - ); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs17.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); - return "test-mode-sarif-id"; + return "dummy-sarif-id"; } const client = getApiClient(); try { @@ -133585,7 +133586,7 @@ async function maybeUploadFailedSarif(config, repositoryNwo, features, logger) { const shouldUpload = getUploadInputOrThrow(workflow, jobName, matrix); if (!["always", "failure-only"].includes( getUploadValue(shouldUpload) - ) || isInTestMode()) { + ) || shouldSkipSarifUpload()) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } const category = getCategoryInputOrThrow(workflow, jobName, matrix); diff --git a/lib/upload-lib.js b/lib/upload-lib.js index a6342ff212..e8db57e5f6 100644 --- a/lib/upload-lib.js +++ b/lib/upload-lib.js @@ -88340,6 +88340,9 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +} function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; if (testingEnvironment === "") { @@ -92367,17 +92370,15 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (isInTestMode()) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path14.join( getTemporaryDirectory(), "payload.json" ); - logger.info( - `In test mode. Results are not uploaded. Saving to ${payloadSaveFile}` - ); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs13.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); - return "test-mode-sarif-id"; + return "dummy-sarif-id"; } const client = getApiClient(); try { diff --git a/lib/upload-sarif-action.js b/lib/upload-sarif-action.js index 7ad72583b5..e768a7fe9a 100644 --- a/lib/upload-sarif-action.js +++ b/lib/upload-sarif-action.js @@ -88457,6 +88457,9 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +} function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; if (testingEnvironment === "") { @@ -93039,17 +93042,15 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (isInTestMode()) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path15.join( getTemporaryDirectory(), "payload.json" ); - logger.info( - `In test mode. Results are not uploaded. Saving to ${payloadSaveFile}` - ); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs14.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); - return "test-mode-sarif-id"; + return "dummy-sarif-id"; } const client = getApiClient(); try { @@ -93570,8 +93571,8 @@ async function run() { core13.setOutput("sarif-id", codeScanningResult.sarifID); } core13.setOutput("sarif-ids", JSON.stringify(uploadResults)); - if (isInTestMode()) { - core13.debug("In test mode. Waiting for processing is disabled."); + if (shouldSkipSarifUpload()) { + core13.debug("SARIF upload disabled. Waiting for processing is disabled."); } else if (getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== void 0) { await waitForProcessing( diff --git a/src/environment.ts b/src/environment.ts index e1daeedc2d..59922c8418 100644 --- a/src/environment.ts +++ b/src/environment.ts @@ -128,4 +128,10 @@ export enum EnvVar { * whether the upload is disabled. This is intended for testing and debugging purposes. */ SARIF_DUMP_DIR = "CODEQL_ACTION_SARIF_DUMP_DIR", + + /** + * Whether to skip uploading SARIF results to GitHub. Intended for testing purposes. + * This setting is implied but is more specific than `CODEQL_ACTION_TEST_MODE`. + */ + SKIP_SARIF_UPLOAD = "CODEQL_ACTION_SKIP_SARIF_UPLOAD", } diff --git a/src/init-action-post-helper.ts b/src/init-action-post-helper.ts index 97bf21adac..7d46095e91 100644 --- a/src/init-action-post-helper.ts +++ b/src/init-action-post-helper.ts @@ -19,8 +19,8 @@ import { delay, getErrorMessage, getRequiredEnvParam, - isInTestMode, parseMatrixInput, + shouldSkipSarifUpload, wrapError, } from "./util"; import { @@ -81,7 +81,7 @@ async function maybeUploadFailedSarif( !["always", "failure-only"].includes( actionsUtil.getUploadValue(shouldUpload), ) || - isInTestMode() + shouldSkipSarifUpload() ) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } diff --git a/src/upload-lib.ts b/src/upload-lib.ts index cfa362b678..98d8439ecf 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -356,18 +356,16 @@ async function uploadPayload( ): Promise { logger.info("Uploading results"); - // If in test mode we don't want to upload the results - if (util.isInTestMode()) { + // If in test mode we don't want to upload the results, + if (util.shouldSkipSarifUpload()) { const payloadSaveFile = path.join( actionsUtil.getTemporaryDirectory(), "payload.json", ); - logger.info( - `In test mode. Results are not uploaded. Saving to ${payloadSaveFile}`, - ); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); - return "test-mode-sarif-id"; + return "dummy-sarif-id"; } const client = api.getApiClient(); diff --git a/src/upload-sarif-action.ts b/src/upload-sarif-action.ts index b9eced9d39..5e6897adad 100644 --- a/src/upload-sarif-action.ts +++ b/src/upload-sarif-action.ts @@ -23,7 +23,7 @@ import { checkDiskUsage, getErrorMessage, initializeEnvironment, - isInTestMode, + shouldSkipSarifUpload, wrapError, } from "./util"; @@ -113,8 +113,8 @@ async function run() { core.setOutput("sarif-ids", JSON.stringify(uploadResults)); // We don't upload results in test mode, so don't wait for processing - if (isInTestMode()) { - core.debug("In test mode. Waiting for processing is disabled."); + if (shouldSkipSarifUpload()) { + core.debug("SARIF upload disabled. Waiting for processing is disabled."); } else if (actionsUtil.getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== undefined) { await upload_lib.waitForProcessing( diff --git a/src/util.ts b/src/util.ts index e7c29ed12e..9dc9a7d247 100644 --- a/src/util.ts +++ b/src/util.ts @@ -764,12 +764,19 @@ export function isGoodVersion(versionSpec: string) { /** * Returns whether we are in test mode. This is used by CodeQL Action PR checks. * - * In test mode, we don't upload SARIF results or status reports to the GitHub API. + * In test mode, we several uploads (SARIF results, status reports, DBs, ...). */ export function isInTestMode(): boolean { return process.env[EnvVar.TEST_MODE] === "true"; } +/** + * Returns whether we specifically want to skip uploading SARIF files. + */ +export function shouldSkipSarifUpload(): boolean { + return isInTestMode() || process.env[EnvVar.SKIP_SARIF_UPLOAD] === "true"; +} + /** * Get the testing environment. * From 882667e383f6770feee4a7f18c5cedadec673c35 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Mon, 6 Oct 2025 15:22:34 +0200 Subject: [PATCH 2/9] Update src/util.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- src/util.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/util.ts b/src/util.ts index 9dc9a7d247..e1f7a15ecc 100644 --- a/src/util.ts +++ b/src/util.ts @@ -764,7 +764,7 @@ export function isGoodVersion(versionSpec: string) { /** * Returns whether we are in test mode. This is used by CodeQL Action PR checks. * - * In test mode, we several uploads (SARIF results, status reports, DBs, ...). + * In test mode, we skip several uploads (SARIF results, status reports, DBs, ...). */ export function isInTestMode(): boolean { return process.env[EnvVar.TEST_MODE] === "true"; From 11e40344144d49f1ba9441e1c8cbbe2e0d526142 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Mon, 6 Oct 2025 15:23:18 +0200 Subject: [PATCH 3/9] Clarify comment about SKIP_SARIF_UPLOAD setting --- src/environment.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/environment.ts b/src/environment.ts index 59922c8418..d9b66b67d9 100644 --- a/src/environment.ts +++ b/src/environment.ts @@ -131,7 +131,7 @@ export enum EnvVar { /** * Whether to skip uploading SARIF results to GitHub. Intended for testing purposes. - * This setting is implied but is more specific than `CODEQL_ACTION_TEST_MODE`. + * This setting is implied by but is more specific than `CODEQL_ACTION_TEST_MODE`. */ SKIP_SARIF_UPLOAD = "CODEQL_ACTION_SKIP_SARIF_UPLOAD", } From 680b07003d39978a705d23d22a2efc5f62a0e924 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Mon, 6 Oct 2025 15:39:29 +0200 Subject: [PATCH 4/9] Specify reason for skipping SARIF upload in logs --- lib/analyze-action.js | 15 +++++++++++---- lib/init-action-post.js | 21 ++++++++++++++++----- lib/upload-lib.js | 15 +++++++++++---- lib/upload-sarif-action.js | 20 ++++++++++++++------ src/environment.ts | 2 +- src/init-action-post-helper.ts | 9 ++++++--- src/upload-lib.ts | 5 +++-- src/upload-sarif-action.ts | 7 ++++--- src/util.ts | 12 +++++++++--- 9 files changed, 75 insertions(+), 31 deletions(-) diff --git a/lib/analyze-action.js b/lib/analyze-action.js index 18725b2fa8..5e8fe46fe1 100644 --- a/lib/analyze-action.js +++ b/lib/analyze-action.js @@ -89773,8 +89773,14 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function shouldSkipSarifUpload() { - return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +function getSarifUploadSkipReason() { + if (isInTestMode()) { + return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; + } + if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { + return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; + } + return null; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -95535,12 +95541,13 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (shouldSkipSarifUpload()) { + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { const payloadSaveFile = path18.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs18.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/init-action-post.js b/lib/init-action-post.js index 71c2588094..b12435b4d6 100644 --- a/lib/init-action-post.js +++ b/lib/init-action-post.js @@ -128072,8 +128072,14 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function shouldSkipSarifUpload() { - return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +function getSarifUploadSkipReason() { + if (isInTestMode()) { + return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; + } + if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { + return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; + } + return null; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -133011,12 +133017,13 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (shouldSkipSarifUpload()) { + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { const payloadSaveFile = path17.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs17.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; @@ -133586,9 +133593,13 @@ async function maybeUploadFailedSarif(config, repositoryNwo, features, logger) { const shouldUpload = getUploadInputOrThrow(workflow, jobName, matrix); if (!["always", "failure-only"].includes( getUploadValue(shouldUpload) - ) || shouldSkipSarifUpload()) { + )) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { + return { upload_failed_run_skipped_because: skipReason }; + } const category = getCategoryInputOrThrow(workflow, jobName, matrix); const checkoutPath = getCheckoutPathInputOrThrow(workflow, jobName, matrix); const databasePath = config.dbLocation; diff --git a/lib/upload-lib.js b/lib/upload-lib.js index e8db57e5f6..d35b895ce8 100644 --- a/lib/upload-lib.js +++ b/lib/upload-lib.js @@ -88340,8 +88340,14 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function shouldSkipSarifUpload() { - return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +function getSarifUploadSkipReason() { + if (isInTestMode()) { + return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; + } + if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { + return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; + } + return null; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -92370,12 +92376,13 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (shouldSkipSarifUpload()) { + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { const payloadSaveFile = path14.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs13.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/upload-sarif-action.js b/lib/upload-sarif-action.js index e768a7fe9a..7bf15775ac 100644 --- a/lib/upload-sarif-action.js +++ b/lib/upload-sarif-action.js @@ -88457,8 +88457,14 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function shouldSkipSarifUpload() { - return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; +function getSarifUploadSkipReason() { + if (isInTestMode()) { + return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; + } + if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { + return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; + } + return null; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -93042,12 +93048,13 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - if (shouldSkipSarifUpload()) { + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { const payloadSaveFile = path15.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs14.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; @@ -93571,8 +93578,9 @@ async function run() { core13.setOutput("sarif-id", codeScanningResult.sarifID); } core13.setOutput("sarif-ids", JSON.stringify(uploadResults)); - if (shouldSkipSarifUpload()) { - core13.debug("SARIF upload disabled. Waiting for processing is disabled."); + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { + core13.debug(`${skipReason}. Waiting for processing is disabled.`); } else if (getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== void 0) { await waitForProcessing( diff --git a/src/environment.ts b/src/environment.ts index d9b66b67d9..6713f57e60 100644 --- a/src/environment.ts +++ b/src/environment.ts @@ -131,7 +131,7 @@ export enum EnvVar { /** * Whether to skip uploading SARIF results to GitHub. Intended for testing purposes. - * This setting is implied by but is more specific than `CODEQL_ACTION_TEST_MODE`. + * This setting is implied by `CODEQL_ACTION_TEST_MODE`, but is more specific. */ SKIP_SARIF_UPLOAD = "CODEQL_ACTION_SKIP_SARIF_UPLOAD", } diff --git a/src/init-action-post-helper.ts b/src/init-action-post-helper.ts index 7d46095e91..f084e64151 100644 --- a/src/init-action-post-helper.ts +++ b/src/init-action-post-helper.ts @@ -20,7 +20,7 @@ import { getErrorMessage, getRequiredEnvParam, parseMatrixInput, - shouldSkipSarifUpload, + getSarifUploadSkipReason, wrapError, } from "./util"; import { @@ -80,11 +80,14 @@ async function maybeUploadFailedSarif( if ( !["always", "failure-only"].includes( actionsUtil.getUploadValue(shouldUpload), - ) || - shouldSkipSarifUpload() + ) ) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { + return { upload_failed_run_skipped_because: skipReason }; + } const category = getCategoryInputOrThrow(workflow, jobName, matrix); const checkoutPath = getCheckoutPathInputOrThrow(workflow, jobName, matrix); const databasePath = config.dbLocation; diff --git a/src/upload-lib.ts b/src/upload-lib.ts index 98d8439ecf..ac87b296f7 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -357,12 +357,13 @@ async function uploadPayload( logger.info("Uploading results"); // If in test mode we don't want to upload the results, - if (util.shouldSkipSarifUpload()) { + const skipReason = util.getSarifUploadSkipReason(); + if (skipReason) { const payloadSaveFile = path.join( actionsUtil.getTemporaryDirectory(), "payload.json", ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/src/upload-sarif-action.ts b/src/upload-sarif-action.ts index 5e6897adad..60d18c8767 100644 --- a/src/upload-sarif-action.ts +++ b/src/upload-sarif-action.ts @@ -23,7 +23,7 @@ import { checkDiskUsage, getErrorMessage, initializeEnvironment, - shouldSkipSarifUpload, + getSarifUploadSkipReason, wrapError, } from "./util"; @@ -113,8 +113,9 @@ async function run() { core.setOutput("sarif-ids", JSON.stringify(uploadResults)); // We don't upload results in test mode, so don't wait for processing - if (shouldSkipSarifUpload()) { - core.debug("SARIF upload disabled. Waiting for processing is disabled."); + const skipReason = getSarifUploadSkipReason(); + if (skipReason) { + core.debug(`${skipReason}. Waiting for processing is disabled.`); } else if (actionsUtil.getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== undefined) { await upload_lib.waitForProcessing( diff --git a/src/util.ts b/src/util.ts index e1f7a15ecc..1a27bb6903 100644 --- a/src/util.ts +++ b/src/util.ts @@ -771,10 +771,16 @@ export function isInTestMode(): boolean { } /** - * Returns whether we specifically want to skip uploading SARIF files. + * Returns whether we specifically want to skip uploading SARIF files, and if so, why. */ -export function shouldSkipSarifUpload(): boolean { - return isInTestMode() || process.env[EnvVar.SKIP_SARIF_UPLOAD] === "true"; +export function getSarifUploadSkipReason(): string | null { + if (isInTestMode()) { + return `SARIF upload is disabled via ${EnvVar.TEST_MODE}`; + } + if (process.env[EnvVar.SKIP_SARIF_UPLOAD] === "true") { + return `SARIF upload is disabled via ${EnvVar.SKIP_SARIF_UPLOAD}`; + } + return null; } /** From 25c8db918a216a2a632b6646e28c958333175433 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Mon, 6 Oct 2025 16:59:45 +0200 Subject: [PATCH 5/9] Revert "Specify reason for skipping SARIF upload in logs" This reverts commit 680b07003d39978a705d23d22a2efc5f62a0e924. --- lib/analyze-action.js | 15 ++++----------- lib/init-action-post.js | 21 +++++---------------- lib/upload-lib.js | 15 ++++----------- lib/upload-sarif-action.js | 20 ++++++-------------- src/environment.ts | 2 +- src/init-action-post-helper.ts | 9 +++------ src/upload-lib.ts | 5 ++--- src/upload-sarif-action.ts | 7 +++---- src/util.ts | 12 +++--------- 9 files changed, 31 insertions(+), 75 deletions(-) diff --git a/lib/analyze-action.js b/lib/analyze-action.js index 5e8fe46fe1..18725b2fa8 100644 --- a/lib/analyze-action.js +++ b/lib/analyze-action.js @@ -89773,14 +89773,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -95541,13 +95535,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path18.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs18.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/init-action-post.js b/lib/init-action-post.js index b12435b4d6..71c2588094 100644 --- a/lib/init-action-post.js +++ b/lib/init-action-post.js @@ -128072,14 +128072,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -133017,13 +133011,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path17.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs17.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; @@ -133593,13 +133586,9 @@ async function maybeUploadFailedSarif(config, repositoryNwo, features, logger) { const shouldUpload = getUploadInputOrThrow(workflow, jobName, matrix); if (!["always", "failure-only"].includes( getUploadValue(shouldUpload) - )) { + ) || shouldSkipSarifUpload()) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - return { upload_failed_run_skipped_because: skipReason }; - } const category = getCategoryInputOrThrow(workflow, jobName, matrix); const checkoutPath = getCheckoutPathInputOrThrow(workflow, jobName, matrix); const databasePath = config.dbLocation; diff --git a/lib/upload-lib.js b/lib/upload-lib.js index d35b895ce8..e8db57e5f6 100644 --- a/lib/upload-lib.js +++ b/lib/upload-lib.js @@ -88340,14 +88340,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -92376,13 +92370,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path14.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs13.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/upload-sarif-action.js b/lib/upload-sarif-action.js index 7bf15775ac..e768a7fe9a 100644 --- a/lib/upload-sarif-action.js +++ b/lib/upload-sarif-action.js @@ -88457,14 +88457,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -93048,13 +93042,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path15.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs14.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; @@ -93578,9 +93571,8 @@ async function run() { core13.setOutput("sarif-id", codeScanningResult.sarifID); } core13.setOutput("sarif-ids", JSON.stringify(uploadResults)); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - core13.debug(`${skipReason}. Waiting for processing is disabled.`); + if (shouldSkipSarifUpload()) { + core13.debug("SARIF upload disabled. Waiting for processing is disabled."); } else if (getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== void 0) { await waitForProcessing( diff --git a/src/environment.ts b/src/environment.ts index 6713f57e60..d9b66b67d9 100644 --- a/src/environment.ts +++ b/src/environment.ts @@ -131,7 +131,7 @@ export enum EnvVar { /** * Whether to skip uploading SARIF results to GitHub. Intended for testing purposes. - * This setting is implied by `CODEQL_ACTION_TEST_MODE`, but is more specific. + * This setting is implied by but is more specific than `CODEQL_ACTION_TEST_MODE`. */ SKIP_SARIF_UPLOAD = "CODEQL_ACTION_SKIP_SARIF_UPLOAD", } diff --git a/src/init-action-post-helper.ts b/src/init-action-post-helper.ts index f084e64151..7d46095e91 100644 --- a/src/init-action-post-helper.ts +++ b/src/init-action-post-helper.ts @@ -20,7 +20,7 @@ import { getErrorMessage, getRequiredEnvParam, parseMatrixInput, - getSarifUploadSkipReason, + shouldSkipSarifUpload, wrapError, } from "./util"; import { @@ -80,14 +80,11 @@ async function maybeUploadFailedSarif( if ( !["always", "failure-only"].includes( actionsUtil.getUploadValue(shouldUpload), - ) + ) || + shouldSkipSarifUpload() ) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - return { upload_failed_run_skipped_because: skipReason }; - } const category = getCategoryInputOrThrow(workflow, jobName, matrix); const checkoutPath = getCheckoutPathInputOrThrow(workflow, jobName, matrix); const databasePath = config.dbLocation; diff --git a/src/upload-lib.ts b/src/upload-lib.ts index ac87b296f7..98d8439ecf 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -357,13 +357,12 @@ async function uploadPayload( logger.info("Uploading results"); // If in test mode we don't want to upload the results, - const skipReason = util.getSarifUploadSkipReason(); - if (skipReason) { + if (util.shouldSkipSarifUpload()) { const payloadSaveFile = path.join( actionsUtil.getTemporaryDirectory(), "payload.json", ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/src/upload-sarif-action.ts b/src/upload-sarif-action.ts index 60d18c8767..5e6897adad 100644 --- a/src/upload-sarif-action.ts +++ b/src/upload-sarif-action.ts @@ -23,7 +23,7 @@ import { checkDiskUsage, getErrorMessage, initializeEnvironment, - getSarifUploadSkipReason, + shouldSkipSarifUpload, wrapError, } from "./util"; @@ -113,9 +113,8 @@ async function run() { core.setOutput("sarif-ids", JSON.stringify(uploadResults)); // We don't upload results in test mode, so don't wait for processing - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - core.debug(`${skipReason}. Waiting for processing is disabled.`); + if (shouldSkipSarifUpload()) { + core.debug("SARIF upload disabled. Waiting for processing is disabled."); } else if (actionsUtil.getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== undefined) { await upload_lib.waitForProcessing( diff --git a/src/util.ts b/src/util.ts index 1a27bb6903..e1f7a15ecc 100644 --- a/src/util.ts +++ b/src/util.ts @@ -771,16 +771,10 @@ export function isInTestMode(): boolean { } /** - * Returns whether we specifically want to skip uploading SARIF files, and if so, why. + * Returns whether we specifically want to skip uploading SARIF files. */ -export function getSarifUploadSkipReason(): string | null { - if (isInTestMode()) { - return `SARIF upload is disabled via ${EnvVar.TEST_MODE}`; - } - if (process.env[EnvVar.SKIP_SARIF_UPLOAD] === "true") { - return `SARIF upload is disabled via ${EnvVar.SKIP_SARIF_UPLOAD}`; - } - return null; +export function shouldSkipSarifUpload(): boolean { + return isInTestMode() || process.env[EnvVar.SKIP_SARIF_UPLOAD] === "true"; } /** From 00a6e13cbfc3c235afc298030cf9b1728b498130 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Mon, 6 Oct 2025 17:01:42 +0200 Subject: [PATCH 6/9] Tweak SARIF skipping logs --- lib/analyze-action.js | 4 +++- lib/init-action-post.js | 4 +++- lib/upload-lib.js | 4 +++- lib/upload-sarif-action.js | 8 ++++++-- src/upload-lib.ts | 4 +++- src/upload-sarif-action.ts | 4 +++- 6 files changed, 21 insertions(+), 7 deletions(-) diff --git a/lib/analyze-action.js b/lib/analyze-action.js index 18725b2fa8..b943c7bd1b 100644 --- a/lib/analyze-action.js +++ b/lib/analyze-action.js @@ -95540,7 +95540,9 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info( + `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs18.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/init-action-post.js b/lib/init-action-post.js index 71c2588094..380a1df2dc 100644 --- a/lib/init-action-post.js +++ b/lib/init-action-post.js @@ -133016,7 +133016,9 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info( + `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs17.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/upload-lib.js b/lib/upload-lib.js index e8db57e5f6..b7c52233ad 100644 --- a/lib/upload-lib.js +++ b/lib/upload-lib.js @@ -92375,7 +92375,9 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info( + `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs13.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/upload-sarif-action.js b/lib/upload-sarif-action.js index e768a7fe9a..08a236c5e6 100644 --- a/lib/upload-sarif-action.js +++ b/lib/upload-sarif-action.js @@ -93047,7 +93047,9 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { getTemporaryDirectory(), "payload.json" ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info( + `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs14.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; @@ -93572,7 +93574,9 @@ async function run() { } core13.setOutput("sarif-ids", JSON.stringify(uploadResults)); if (shouldSkipSarifUpload()) { - core13.debug("SARIF upload disabled. Waiting for processing is disabled."); + core13.debug( + "SARIF upload disabled via environment variable. Waiting for processing is disabled." + ); } else if (getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== void 0) { await waitForProcessing( diff --git a/src/upload-lib.ts b/src/upload-lib.ts index 98d8439ecf..8393ddba9f 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -362,7 +362,9 @@ async function uploadPayload( actionsUtil.getTemporaryDirectory(), "payload.json", ); - logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); + logger.info( + `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}`, + ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/src/upload-sarif-action.ts b/src/upload-sarif-action.ts index 5e6897adad..fdc365488f 100644 --- a/src/upload-sarif-action.ts +++ b/src/upload-sarif-action.ts @@ -114,7 +114,9 @@ async function run() { // We don't upload results in test mode, so don't wait for processing if (shouldSkipSarifUpload()) { - core.debug("SARIF upload disabled. Waiting for processing is disabled."); + core.debug( + "SARIF upload disabled via environment variable. Waiting for processing is disabled.", + ); } else if (actionsUtil.getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== undefined) { await upload_lib.waitForProcessing( From 86b2ad66467bec6e0e45071af0ff547052830425 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Tue, 7 Oct 2025 10:36:45 +0200 Subject: [PATCH 7/9] Remove unneeded comment --- src/upload-lib.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/upload-lib.ts b/src/upload-lib.ts index 8393ddba9f..68e2004d86 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -356,7 +356,6 @@ async function uploadPayload( ): Promise { logger.info("Uploading results"); - // If in test mode we don't want to upload the results, if (util.shouldSkipSarifUpload()) { const payloadSaveFile = path.join( actionsUtil.getTemporaryDirectory(), From 1b09eb4cccffa2e41a48a47920632069b9896201 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Tue, 7 Oct 2025 17:16:28 +0200 Subject: [PATCH 8/9] Address review --- lib/analyze-action.js | 2 +- lib/init-action-post.js | 2 +- lib/upload-lib.js | 2 +- lib/upload-sarif-action.js | 4 ++-- src/upload-lib.ts | 2 +- src/upload-sarif-action.ts | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/analyze-action.js b/lib/analyze-action.js index 8f2d4578ab..d7bddb8524 100644 --- a/lib/analyze-action.js +++ b/lib/analyze-action.js @@ -95541,7 +95541,7 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { "payload.json" ); logger.info( - `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + `SARIF upload disabled by an environment variable. Saving to ${payloadSaveFile}` ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs18.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); diff --git a/lib/init-action-post.js b/lib/init-action-post.js index 007d941af2..cf52eb88a1 100644 --- a/lib/init-action-post.js +++ b/lib/init-action-post.js @@ -133017,7 +133017,7 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { "payload.json" ); logger.info( - `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + `SARIF upload disabled by an environment variable. Saving to ${payloadSaveFile}` ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs17.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); diff --git a/lib/upload-lib.js b/lib/upload-lib.js index 295f777e81..83ee93767d 100644 --- a/lib/upload-lib.js +++ b/lib/upload-lib.js @@ -92376,7 +92376,7 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { "payload.json" ); logger.info( - `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + `SARIF upload disabled by an environment variable. Saving to ${payloadSaveFile}` ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs13.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); diff --git a/lib/upload-sarif-action.js b/lib/upload-sarif-action.js index 3c0b78c980..0df2148364 100644 --- a/lib/upload-sarif-action.js +++ b/lib/upload-sarif-action.js @@ -93048,7 +93048,7 @@ async function uploadPayload(payload, repositoryNwo, logger, target) { "payload.json" ); logger.info( - `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}` + `SARIF upload disabled by an environment variable. Saving to ${payloadSaveFile}` ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs14.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); @@ -93575,7 +93575,7 @@ async function run() { core13.setOutput("sarif-ids", JSON.stringify(uploadResults)); if (shouldSkipSarifUpload()) { core13.debug( - "SARIF upload disabled via environment variable. Waiting for processing is disabled." + "SARIF upload disabled by an environment variable. Waiting for processing is disabled." ); } else if (getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== void 0) { diff --git a/src/upload-lib.ts b/src/upload-lib.ts index 68e2004d86..f3db971941 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -362,7 +362,7 @@ async function uploadPayload( "payload.json", ); logger.info( - `SARIF upload disabled via environment variable. Saving to ${payloadSaveFile}`, + `SARIF upload disabled by an environment variable. Saving to ${payloadSaveFile}`, ); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); diff --git a/src/upload-sarif-action.ts b/src/upload-sarif-action.ts index fdc365488f..a2ef43eb44 100644 --- a/src/upload-sarif-action.ts +++ b/src/upload-sarif-action.ts @@ -115,7 +115,7 @@ async function run() { // We don't upload results in test mode, so don't wait for processing if (shouldSkipSarifUpload()) { core.debug( - "SARIF upload disabled via environment variable. Waiting for processing is disabled.", + "SARIF upload disabled by an environment variable. Waiting for processing is disabled.", ); } else if (actionsUtil.getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== undefined) { From d05f2255a087b7661ba811697734d364a4001eae Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Wed, 8 Oct 2025 09:33:02 +0200 Subject: [PATCH 9/9] Tweak comment --- src/environment.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/environment.ts b/src/environment.ts index d9b66b67d9..7f554c7627 100644 --- a/src/environment.ts +++ b/src/environment.ts @@ -131,7 +131,7 @@ export enum EnvVar { /** * Whether to skip uploading SARIF results to GitHub. Intended for testing purposes. - * This setting is implied by but is more specific than `CODEQL_ACTION_TEST_MODE`. + * This setting is more specific than `CODEQL_ACTION_TEST_MODE`, which implies this option. */ SKIP_SARIF_UPLOAD = "CODEQL_ACTION_SKIP_SARIF_UPLOAD", }