Repository navigation
Report how long toolcache cleanup takes - #4302
Open
henrymercer wants to merge 2 commits into
Open
henrymercer wants to merge 2 commits into
henrymercer wants to merge 2 commits into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
An active finding remains because the test does not verify the new per-version deletion-duration log message or which deletion the timer covers.
1 open issue
What changed in this PR
This pull request adds observability to CodeQL toolcache cleanup by reporting deletion timing in logs and telemetry.
Changes:
- Logs the duration of each successfully deleted CodeQL toolcache version.
- Records total cleanup time as
durationMsin cleanup telemetry. - Updates unit tests and the generated JavaScript bundle.
Minor nit: add an assertion covering the per-version deletion-duration log message.
| File | Summary |
|---|---|
src/tools-download.ts |
Measures and logs the duration of each toolcache version deletion. |
src/setup-codeql.ts |
Records total toolcache cleanup duration in telemetry. |
src/setup-codeql.test.ts |
Verifies aggregate cleanup timing and extracts the duration diagnostic attribute. |
lib/entry-points.js |
Generated JavaScript reflecting the TypeScript changes. |
This pull request is ready to be approved.
Review effort: Lite (auto)
henrymercer
marked this pull request as ready for review
November 4, 2026 16:42
This branch has not been deployed
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 PR adds the time taken to delete each version to the "Deleted the CodeQL tools" log message, and records the total time taken by the cleanup as
durationMsin thecodeql-action/toolcache-bundle-cleanuptelemetry diagnostic so we can see how long it takes across runs.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