Skip to content

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

Merged
merged 3 commits into from
Aug 5, 2025

Conversation

henrymercer
Copy link
Contributor

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

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@henrymercer henrymercer requested a review from a team as a code owner August 4, 2025 16:53
@Copilot Copilot AI review requested due to automatic review settings August 4, 2025 16:53
Copilot

This comment was marked as outdated.

@henrymercer henrymercer force-pushed the henrymercer/deprecate-cleanup-level branch from 1702cb6 to f9d6919 Compare August 4, 2025 17:00
@henrymercer henrymercer requested a review from mbg August 5, 2025 09:53
mbg
mbg previously approved these changes Aug 5, 2025
Copy link
Member

@mbg mbg left a 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>
@Copilot Copilot AI review requested due to automatic review settings August 5, 2025 10:08
Copy link
Contributor

@Copilot Copilot AI left a 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

@henrymercer henrymercer requested a review from mbg August 5, 2025 10:08
@henrymercer henrymercer enabled auto-merge August 5, 2025 10:09
@henrymercer henrymercer merged commit bbfff2f into main Aug 5, 2025
282 checks passed
@henrymercer henrymercer deleted the henrymercer/deprecate-cleanup-level branch August 5, 2025 10:22
@github-actions github-actions bot mentioned this pull request Aug 7, 2025
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants