Deprecate the 'cleanup-level' option#2999
Merged
henrymercer merged 3 commits intomainfrom Aug 5, 2025
Merged
Conversation
1702cb6 to
f9d6919
Compare
mbg
previously approved these changes
Aug 5, 2025
Member
mbg
left a comment
There was a problem hiding this comment.
Nice! That's convenient given the changes that were needed for overlay databases. Thanks for noticing this and making the change.
Co-authored-by: Michael B. Gale <mbg@github.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the cleanup-level input option for the CodeQL Action's analyze step, as it no longer serves a practical purpose since the Action stopped writing intermediate results to the database in version 2.2.5.
- Removes the
cleanup-levelinput parameter usage and hardcodes cleanup behavior - Adds deprecation warning to inform users they can safely remove this input
- Updates action description and changelog to reflect the deprecation
Reviewed Changes
Copilot reviewed 8 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/analyze-action.ts | Adds deprecation warning and changes cleanup level logic to use hardcoded values |
| lib/analyze-action.js | Generated JavaScript equivalent of the TypeScript changes |
| src/analyze-action-input.test.ts | Removes test stub for deprecated cleanup-level input |
| src/analyze-action-env.test.ts | Removes test stub for deprecated cleanup-level input |
| lib/analyze-action-input.test.js | Generated JavaScript test file changes |
| lib/analyze-action-env.test.js | Generated JavaScript test file changes |
| analyze/action.yml | Updates input description to mark as deprecated and removes default value |
| CHANGELOG.md | Documents the deprecation change |
mbg
approved these changes
Aug 5, 2025
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 CodeQL Action has not written intermediate results to the database since version 2.2.5, so this option now has little to no practical use.
This PR keeps the input around but marks it as deprecated in the description and adds an info level log notifying users that they can safely remove the input from their workflows.
Merge / deployment checklist