Delete CLI output-cache file during init - #4097
Open
mario-campos wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Warning
- Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.
Pull request overview
Prevents stale CodeQL CLI output caches from persisting across runs on self-hosted runners.
Changes:
- Exports the command-cache path helper.
- Deletes the cache during initialization.
- Updates generated JavaScript.
Show a summary per file
| File | Description |
|---|---|
src/init-action.ts |
Adds cache deletion during initialization. |
src/cli/output-cache.ts |
Exports the cache-path helper. |
lib/entry-points.js |
Generated artifact; excluded from review. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Files excluded by content exclusion policy (1)
- lib/entry-points.js
- Files reviewed: 2/3 changed files
- Comments generated: 1
- Review effort level: Balanced
Comment on lines
+300
to
+303
| // Delete the CLI output-cache file if it exists, to avoid | ||
| // accidentally reusing a stale version from a previous run. | ||
| try { | ||
| fs.unlinkSync(getCommandCacheFilePath(actionState.env)); |
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.
The CLI output-cache file, which was introduced in #4081, is not meant to be used between runs—only steps. On non-ephemeral (i.e. self-hosted) runners, if the temp directories are not cleared between runs, the Action may load a previous ("stale") cache file, which may lead to unexpected results if the CLI has changed.
To prevent that from happening, with this PR, the Action will proactively delete the cache file at the expected location early in the
initstep, if one exists.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?
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