Add new quality-queries input
#2917
Open
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new quality-queries input to the init action and propagates it through configuration parsing and SARIF generation, enabling code quality queries to be combined and filtered alongside existing query inputs.
- Adds
quality-queriestoinit-action.tsandaction.yml - Extends
config-utilsandcodeqlmodules to parse and inject quality queries - Updates unit tests and generated workflows to cover the new input
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/init-action.ts | Propagate qualityQueriesInput from action inputs |
| src/config-utils.ts | Extend calculateAugmentation and related interfaces |
| src/config-utils.test.ts | Add qualityQueriesInput to test setup and cases |
| src/codeql.ts | Inject qualityQueriesInput into SARIF config building |
| init/action.yml | Declare new quality-queries input |
| pr-checks/checks/quality-queries.yml | Add PR check workflow for quality queries |
| lib/init-action.js | Build output for quality-queries handling |
| lib/config-utils.js | Compiled parsing and augmentation updates |
| lib/config-utils.test.js | Compiled test adjustments for quality queries |
| lib/codeql.js | Compiled SARIF injection updates |
| .github/workflows/__quality-queries.yml | Generated workflow for the new PR check |
Comments suppressed due to low confidence (3)
src/config-utils.test.ts:860
- Add a test case where both
queriesandquality-queriesinputs are provided together (with and without+prefix) to verify that they merge correctly into the resultingqueriesInputandqualityQueriesInputproperties.
// (after existing tests for quality queries)
esbena
reviewed
Jun 11, 2025
| @@ -83,6 +83,9 @@ inputs: | |||
| queries: | |||
| description: Comma-separated list of additional queries to run. By default, this overrides the same setting in a configuration file; prefix with "+" to use both sets of queries. | |||
| required: false | |||
| quality-queries: | |||
| description: Comma-separated list of code quality queries to run. | |||
There was a problem hiding this comment.
- Does this also support the
+semantics ofqueriesabove? - Does the user need to know what the difference is between these two inputs? What happens if a query is present in both? What if a non-quality query is present in the quality suite?...
Comment on lines
+1222
to
+1234
| if ( | ||
| config.augmentationProperties.queriesInput || | ||
| config.augmentationProperties.qualityQueriesInput | ||
| ) { | ||
| if (config.augmentationProperties.queriesInputCombines) { | ||
| augmentedConfig.queries = (augmentedConfig.queries || []).concat( | ||
| config.augmentationProperties.queriesInput, | ||
| config.augmentationProperties.queriesInput || [], | ||
| config.augmentationProperties.qualityQueriesInput || [], | ||
| ); | ||
| } else { | ||
| augmentedConfig.queries = config.augmentationProperties.queriesInput; | ||
| augmentedConfig.queries = ( | ||
| config.augmentationProperties.queriesInput || [] | ||
| ).concat(config.augmentationProperties.qualityQueriesInput || []); |
There was a problem hiding this comment.
Nit: deduplication. Perhaps introduce a shared variable.
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 a new
quality-queriesinput to theinitaction. Fundamentally, this behaves the same as thequeriesinput and propagates a list of queries to the CLI. The list of queries given in thequality-queriesinput is combined with thequeriesinput and configuration file, as expected.The intention here is that this will later allow us to filter SARIF results depending on which input the query responsible for the alert belongs to.
Merge / deployment checklist