-
Notifications
You must be signed in to change notification settings - Fork 411
Remove add-snippets input
#3239
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
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 removes the deprecated add-snippets input from the analyze action, which has been deprecated since CodeQL Action 3.26.4 in August 2024. The removal cleans up the codebase by eliminating the associated input parameter, helper function, and all references throughout the action's implementation.
Key changes:
- Removed the
add-snippetsinput definition fromanalyze/action.yml - Deleted the
getAddSnippetsFlag()utility function and its tests - Removed the
addSnippetsFlagparameter fromrunQueries()anddatabaseInterpretResults()functions and all their call sites - Updated CHANGELOG.md to document this breaking change
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| analyze/action.yml | Removed the deprecated add-snippets input definition |
| src/util.ts | Removed the getAddSnippetsFlag() helper function |
| src/util.test.ts | Removed tests for the deleted getAddSnippetsFlag() function |
| src/codeql.ts | Removed addSnippetsFlag parameter from databaseInterpretResults() interface and implementation |
| src/analyze.ts | Removed addSnippetsFlag parameter from runQueries() function signature |
| src/analyze-action.ts | Removed the call to getAddSnippetsFlag() when invoking runQueries() |
| src/analyze.test.ts | Removed addSnippetsFlag variable and parameter from test |
| src/analyze-action-input.test.ts | Updated argument index in test assertion after parameter removal |
| src/analyze-action-env.test.ts | Updated argument index in test assertion after parameter removal |
| CHANGELOG.md | Added entry documenting the removal of the add-snippets input |
| lib/*.js | Generated JavaScript code reflecting the TypeScript changes |
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.
A lot of folks won't see the changelog, so perhaps it makes sense to create a warning when the input is specified to inform users that it is ignored.
3b10402 to
4ae68af
Compare
Co-authored-by: Esben Sparre Andreasen <[email protected]>
This PR removes the
add-snippetsinput from theanalyzeaction. This input has been deprecated since CodeQL Action 3.26.4 in August 2024 when this removal was announced.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
analysis-kinds: code-scanning).analysis-kinds: code-quality).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?
Merge / deployment checklist