robojerk/codeql-action

Only upload upload-sarif debug artifacts at most once

Browse source 
Previously, we uploaded combined SARIF artifacts in both the `analyze-post` and `upload-sarif-post` steps. This change ensures that these artifacts are uploaded at most once — in `analyze-post` if it is a first-party run and `upload-sarif-post` if it is a third-party run.

This is a defensive check because as we upgrade to the new `artifact` dependencies we will not be able to upload artifacts to the same artifact directory.
This commit is contained in:
Angela P Wen 2024-09-11 15:11:27 -07:00
parent b296f2676c
commit c098b253f6
2 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/analyze-action-post.ts
View file

@ -7,6 +7,7 @@ import * as core from "@actions/core";
import * as analyzeActionPostHelper from "./analyze-action-post-helper"; import * as analyzeActionPostHelper from "./analyze-action-post-helper";
import * as debugArtifacts from "./debug-artifacts"; import * as debugArtifacts from "./debug-artifacts";
import { EnvVar } from "./environment";
import * as uploadSarifActionPostHelper from "./upload-sarif-action-post-helper"; import * as uploadSarifActionPostHelper from "./upload-sarif-action-post-helper";
import { wrapError } from "./util"; import { wrapError } from "./util";
@ -14,11 +15,13 @@ async function runWrapper() {
try { try {
await analyzeActionPostHelper.run(); await analyzeActionPostHelper.run();
// Also run the upload-sarif post action since we're potentially running // Upload SARIF artifacts if we determine that this is a first-party analysis run.
// the same steps in the analyze action. // For third-party runs, this artifact will be uploaded in the `upload-sarif-post` step.
await uploadSarifActionPostHelper.uploadArtifacts( if (process.env[EnvVar.INIT_ACTION_HAS_RUN] === "true") {
debugArtifacts.uploadDebugArtifacts, await uploadSarifActionPostHelper.uploadArtifacts(
); debugArtifacts.uploadDebugArtifacts,
);
}
} catch (error) { } catch (error) {
core.setFailed( core.setFailed(
`analyze post-action step failed: ${wrapError(error).message}`, `analyze post-action step failed: ${wrapError(error).message}`,

11
src/upload-sarif-action-post.ts
View file

@ -6,14 +6,19 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import * as debugArtifacts from "./debug-artifacts"; import * as debugArtifacts from "./debug-artifacts";
import { EnvVar } from "./environment";
import * as uploadSarifActionPostHelper from "./upload-sarif-action-post-helper"; import * as uploadSarifActionPostHelper from "./upload-sarif-action-post-helper";
import { wrapError } from "./util"; import { wrapError } from "./util";
async function runWrapper() { async function runWrapper() {
try { try {
await uploadSarifActionPostHelper.uploadArtifacts( // Upload SARIF artifacts if we determine that this is a third-party analysis run.
debugArtifacts.uploadDebugArtifacts, // For first-party runs, this artifact will be uploaded in the `analyze-post` step.
); if (process.env[EnvVar.INIT_ACTION_HAS_RUN] !== "true") {
await uploadSarifActionPostHelper.uploadArtifacts(
debugArtifacts.uploadDebugArtifacts,
);
}
} catch (error) { } catch (error) {
core.setFailed( core.setFailed(
`upload-sarif post-action step failed: ${wrapError(error).message}`, `upload-sarif post-action step failed: ${wrapError(error).message}`,