-
Notifications
You must be signed in to change notification settings - Fork 377
Deprecate the 'cleanup-level' option #2999
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
1702cb6
to
f9d6919
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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-level
input 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 |
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