Skip to content

Use uploadSarif rather than uploadFiles in analyze action #3206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbg merged 7 commits into from
Oct 22, 2025
Merged

Use uploadSarif rather than uploadFiles in analyze action #3206

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2ade8a0
Use `uploadSarif` rather than `uploadFiles` in `analyze` action
mbg Oct 14, 2025
aa048ac
Merge branch 'main' into mbg/analyze/use-upload-sarif
mbg Oct 21, 2025
02b2c3a
Fix style inconsistency
mbg Oct 22, 2025
f88cb01
Add `AnalyzeUseNewUpload` feature
mbg Oct 22, 2025
b7c814c
Gate `uploadSarif` behind FF, use old implementation otherwise
mbg Oct 22, 2025
c98d5a9
Use `checkoutPath` and `category` constants consistently
mbg Oct 22, 2025
ebd514f
Address review comments
mbg Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Use uploadSarif rather than uploadFiles in analyze action
  • Loading branch information
@mbg
mbg committed Oct 14, 2025
commit 2ade8a09a34039864bb092e1cbdd0d0aebd218a0
152 changes: 100 additions & 52 deletions lib/analyze-action.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

68 changes: 33 additions & 35 deletions src/analyze-action.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,7 @@ import { getApiDetails, getGitHubVersion } from "./api-client";
import { runAutobuild } from "./autobuild";
import { getTotalCacheSize, shouldStoreCache } from "./caching-utils";
import { getCodeQL } from "./codeql";
import {
Config,
getConfig,
isCodeQualityEnabled,
isCodeScanningEnabled,
} from "./config-utils";
import { Config, getConfig } from "./config-utils";
import { uploadDatabases } from "./database-upload";
import {
DependencyCacheUploadStatusReport,
Expand Down Expand Up @@ -52,6 +47,7 @@ import {
} from "./trap-caching";
import * as uploadLib from "./upload-lib";
import { UploadResult } from "./upload-lib";
import { uploadSarif } from "./upload-sarif";
import * as util from "./util";

interface AnalysisStatusReport
Expand Down Expand Up @@ -211,7 +207,9 @@ async function runAutobuildIfLegacyGoWorkflow(config: Config, logger: Logger) {

async function run() {
const startedAt = new Date();
let uploadResult: UploadResult | undefined = undefined;
let uploadResults:
| Partial<Record<analyses.AnalysisKind, UploadResult>>
| undefined = undefined;
let runStats: QueriesStatusReport | undefined = undefined;
let config: Config | undefined = undefined;
let trapCacheCleanupTelemetry: TrapCacheCleanupStatusReport | undefined =
Expand Down Expand Up @@ -343,30 +341,25 @@ async function run() {
core.setOutput("sarif-output", path.resolve(outputDir));
const uploadInput = actionsUtil.getOptionalInput("upload");
if (runStats && actionsUtil.getUploadValue(uploadInput) === "always") {
if (isCodeScanningEnabled(config)) {
uploadResult = await uploadLib.uploadFiles(
outputDir,
actionsUtil.getRequiredInput("checkout_path"),
actionsUtil.getOptionalInput("category"),
features,
logger,
analyses.CodeScanning,
);
core.setOutput("sarif-id", uploadResult.sarifID);
}

if (isCodeQualityEnabled(config)) {
const analysis = analyses.CodeQuality;
const qualityUploadResult = await uploadLib.uploadFiles(
outputDir,
actionsUtil.getRequiredInput("checkout_path"),
actionsUtil.getOptionalInput("category"),
features,
logger,
analysis,
);
core.setOutput("quality-sarif-id", qualityUploadResult.sarifID);
}
const checkoutPath = actionsUtil.getRequiredInput("checkout_path");
const category = actionsUtil.getOptionalInput("category");

uploadResults = await uploadSarif(
logger,
features,
checkoutPath,
outputDir,
category,
);

core.setOutput(
"sarif-id",
uploadResults[analyses.AnalysisKind.CodeScanning]?.sarifID,
);
core.setOutput(
"quality-sarif-id",
uploadResults[analyses.AnalysisKind.CodeQuality]?.sarifID,
);
} else {
logger.info("Not uploading results");
}
Expand Down Expand Up @@ -408,12 +401,13 @@ async function run() {
if (util.isInTestMode()) {
logger.debug("In test mode. Waiting for processing is disabled.");
} else if (
uploadResult !== undefined &&
uploadResults !== undefined &&
uploadResults[analyses.AnalysisKind.CodeScanning] !== undefined &&
actionsUtil.getRequiredInput("wait-for-processing") === "true"
) {
await uploadLib.waitForProcessing(
getRepositoryNwo(),
uploadResult.sarifID,
uploadResults[analyses.AnalysisKind.CodeScanning].sarifID,
getActionsLogger(),
);
}
Expand Down Expand Up @@ -450,13 +444,17 @@ async function run() {
return;
}

if (runStats && uploadResult) {
if (
runStats &&
uploadResults &&
uploadResults[analyses.AnalysisKind.CodeScanning]
) {
await sendStatusReport(
startedAt,
config,
{
...runStats,
...uploadResult.statusReport,
...uploadResults[analyses.AnalysisKind.CodeScanning].statusReport,
},
undefined,
trapCacheUploadTime,
Expand Down
Loading