Cache CLI version information across Actions steps#3943
Open
henrymercer wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR persists CodeQL CLI version information across GitHub Actions steps (via an exported env var) so later steps can reuse it instead of repeatedly invoking codeql version, reducing JVM startups and CLI calls.
Changes:
- Persist
{ cmd, version }intoCODEQL_ACTION_CLI_VERSION_INFOwhen first computing the CLI version. - Teach
getVersion()to reuse the persisted version info keyed by CLI path. - Avoid re-running the CLI for
printVersion()by logging the cachedgetVersion()result.
Show a summary per file
| File | Description |
|---|---|
| src/util.ts | Adds persistence of version info via env var and enables cross-step reuse. |
| src/util.test.ts | Adds unit tests for reusing/ignoring persisted version info. |
| src/environment.ts | Introduces EnvVar.CODEQL_VERSION_INFO for cross-step persistence. |
| src/codeql.ts | Switches version lookup/printing to reuse cached/persisted version info. |
| lib/entry-points.js | Generated build output updated to reflect the TypeScript changes. |
Copilot's findings
- Files reviewed: 4/5 changed files
- Comments generated: 3
fb1ee9f to
bab673d
Compare
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.
Persist CLI version information across Actions steps to avoid calling
codeql versionin each step. This saves 3 to 6 calls (and associated JVM startups) in a typical analysis job.We use the path to the CodeQL CLI as a cache key. This is robust to setting up a different CLI with
initorsetup-codeqlin the same job, but if a user hotswaps the CLI with a different mechanism and keeps the path the same, we are going to have the wrong version information. That seems like a rare enough case to be acceptable, but if we care about this, we could introduce more data into the cache key (at the cost of some performance).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