Fix upload-sarif potentially initialising CodeQL twice (second attempt)#3505
Open
Fix upload-sarif potentially initialising CodeQL twice (second attempt)#3505
upload-sarif potentially initialising CodeQL twice (second attempt)#3505Conversation
3 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the upload-sarif flow to avoid potentially initializing the CodeQL CLI more than once by moving CodeQL acquisition/initialization earlier and threading a shared CodeQL getter + temp directory through SARIF post-processing.
Changes:
- Extend
postProcessAndUploadSarif/postProcessSarifFilesto accept aCodeQLGetterand temp directory, so combining SARIF via CLI can reuse a single CodeQL instance. - Add
getOrInitCodeQLcaching inupload-sarif-actionand introduceminimalInitCodeQLinupload-libfor upload-only initialization. - Update call sites and tests (
analyze,initpost helper, and upload-sarif tests) for the new parameter flow.
Reviewed changes
Copilot reviewed 7 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/upload-sarif.ts | Threads tempPath + getCodeQL into SARIF post-processing. |
| src/upload-sarif.test.ts | Updates stubs/calls to match the new postProcessAndUploadSarif signature. |
| src/upload-sarif-action.ts | Adds cached CodeQL initialization and ensures temp dir/config are determined up front. |
| src/upload-lib.ts | Introduces minimalInitCodeQL, adds CodeQLGetter, and propagates getter/temp dir into CLI SARIF combining + upload flow. |
| src/init-action-post-helper.ts | Updates failed-SARIF upload to pass tempDir + codeql into uploadFiles. |
| src/init-action-post-helper.test.ts | Adjusts expectations for updated uploadFiles signature. |
| src/analyze-action.ts | Passes config.tempDir and a CodeQLGetter into postProcessAndUploadSarif. |
henrymercer
reviewed
Feb 24, 2026
Contributor
henrymercer
left a comment
There was a problem hiding this comment.
Looks good, but do we actually have a PR check that tests this behaviour? It would need to:
- not call
init - upload multiple SARIF files
| sarifFiles: string[], | ||
| gitHubVersion: GitHubVersion, | ||
| features: FeatureEnablement, | ||
| _features: FeatureEnablement, |
Contributor
There was a problem hiding this comment.
Drive-by cleanup: Remove this arg?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a fresh attempt at #3006 based on the suggestion in #3006 (review).
This wasn't a priority to fix, but I am working on something else that requires a
CodeQLinstance inupload-sarifand thought it would make sense to address this first.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
dynamicworkflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.upload-sarifaction.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist