Skip to content

Improve feedback about what files are being uploaded in the upload-sarif Action. #14

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
chrisgavin merged 4 commits into from
May 1, 2020
Merged

Improve feedback about what files are being uploaded in the upload-sarif Action. #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d2700f
Increase the log level of the message showing what SARIF files were u…
chrisgavin May 1, 2020
b6a0306
Fail the upload action if uploading a folder with no SARIF files in.
chrisgavin May 1, 2020
4e9886a
Stop the upload action early if no files will be uploaded.
chrisgavin May 1, 2020
8ff10b4
Merge branch 'master' into better-feedback-folder-uploads
chrisgavin May 1, 2020
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
6 changes: 5 additions & 1 deletion lib/upload-lib.js
View file
Open in desktop

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

6 changes: 5 additions & 1 deletion src/upload-lib.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ export async function upload(input: string) {
const sarifFiles = fs.readdirSync(input)
.filter(f => f.endsWith(".sarif"))
.map(f => path.resolve(input, f));
if (sarifFiles.length === 0) {
core.setFailed("No SARIF files found to upload in \"" + input + "\".");
Copy link
Contributor

@robertbrignull robertbrignull May 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

core.setFailed doesn't abort, so we'd still try to upload the emptyset of files.
I think it would be better to return here, but it's perhaps not essential.

Copy link
Contributor

@robertbrignull robertbrignull May 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But to clarify, this PR is a strict improvement as it is, so I have no opposition to merging as it is.

return;
}
await uploadFiles(sarifFiles);
} else {
await uploadFiles([input]);
Expand All @@ -134,7 +138,7 @@ async function uploadFiles(sarifFiles: string[]) {
const analysisName = util.getRequiredEnvParam('GITHUB_WORKFLOW');
const startedAt = process.env[sharedEnv.CODEQL_ACTION_STARTED_AT];

core.debug("Uploading sarif files: " + JSON.stringify(sarifFiles));
core.info("Uploading sarif files: " + JSON.stringify(sarifFiles));
let sarifPayload = combineSarifFiles(sarifFiles);
sarifPayload = fingerprints.addFingerprints(sarifPayload);

Expand Down