Skip to content

Commit

Permalink
Merge pull request #1007 from github/wait-for-processing-2
Browse files Browse the repository at this point in the history
Re-enable waiting for processing by default, using the new API semantics.
  • Loading branch information
chrisgavin authored Apr 14, 2022
2 parents 7a12645 + e7869d5 commit c5c5bda
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 26 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## [UNRELEASED]

- Add `working-directory` input to the `autobuild` action. [#1024](https://github.com/github/codeql-action/pull/1024)
- The `analyze` and `upload-sarif` actions will now wait up to 2 minutes for processing to complete after they have uploaded the results so they can report any processing errors that occurred. This behavior can be disabled by setting the `wait-for-processing` action input to `"false"`. [#1007](https://github.com/github/codeql-action/pull/1007)

## 2.1.8 - 08 Apr 2022

Expand Down
2 changes: 1 addition & 1 deletion analyze/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ inputs:
wait-for-processing:
description: If true, the Action will wait for the uploaded SARIF to be processed before completing.
required: true
default: "false"
default: "true"
token:
default: ${{ github.token }}
matrix:
Expand Down
16 changes: 4 additions & 12 deletions lib/upload-lib.js

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

2 changes: 1 addition & 1 deletion lib/upload-lib.js.map

Large diffs are not rendered by default.

16 changes: 5 additions & 11 deletions src/upload-lib.ts
Original file line number Diff line number Diff line change
Expand Up @@ -485,23 +485,17 @@ export async function waitForProcessing(
logger.info(`Analysis upload status is ${status}.`);
if (status === "complete") {
break;
} else if (status === "pending") {
logger.debug("Analysis processing is still pending...");
} else if (status === "failed") {
throw new Error(
`Code Scanning could not process the submitted SARIF file:\n${response.data.errors}`
);
}
} catch (e) {
if (util.isHTTPError(e)) {
switch (e.status) {
case 404:
logger.debug("Analysis is not found yet...");
break; // Note this breaks from the case statement, not the outer loop.
default:
throw e;
}
} else {
throw e;
}
logger.warning(
`An error occurred checking the status of the delivery. ${e} It should still be processed in the background, but errors that occur during processing may not be reported.`
);
}
await util.delay(STATUS_CHECK_FREQUENCY_MILLISECONDS);
}
Expand Down
2 changes: 1 addition & 1 deletion upload-sarif/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ inputs:
wait-for-processing:
description: If true, the Action will wait for the uploaded SARIF to be processed before completing.
required: true
default: "false"
default: "true"
outputs:
sarif-id:
description: The ID of the uploaded SARIF file.
Expand Down

0 comments on commit c5c5bda

Please sign in to comment.