Persist CodeQL version output to file rather than environment - #4081
Open
mario-campos wants to merge 1 commit into
Open
Persist CodeQL version output to file rather than environment#4081mario-campos wants to merge 1 commit into
mario-campos wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Moves persisted CodeQL CLI version metadata from an environment variable to a temporary JSON file.
Changes:
- Writes and reads version metadata from
$CODEQL_ACTION_TEMP/version.json. - Removes the obsolete environment variable.
- Updates persistence tests.
Show a summary per file
| File | Description |
|---|---|
src/util.ts |
Implements file-based version caching. |
src/util.test.ts |
Updates cache-reading tests. |
src/environment.ts |
Removes the old cache environment variable. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 1
- Review effort level: Balanced
Comment on lines
+692
to
+695
| const serialized = fs.readFileSync( | ||
| getPathToCodeQLVersionCacheFile(env), | ||
| "utf8", | ||
| ); |
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.
Currently, the output of
codeql versionis cached and persisted between steps as an environment variable. This is fine, for now, but, as we begin to cache more of the CLI, we should persist that output to a file instead. This PR begins that process by persisting the output ofcodeql versionto$CODEQL_ACTION_TEMP/version.jsoninstead of$CODEQL_ACTION_CLI_VERSION_INFO.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.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