More readable error message for invalid queries block and invalid query-filters block - #1208
Merged
aeisenberg merged 5 commits intoAug 23, 2022
Merged
aeisenberg merged 5 commits into
aeisenberg merged 5 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
When someone creates an invalid `queries` entry in the codeql config
file, like this:
```
queries:
- foo.ql
```
THe error message is confusing, looking like this:
```
Error: Cannot use 'in' operator to search for 'uses' in ql/ql/src
TypeError: Cannot use 'in' operator to search for 'uses' in ql/ql/src
at loadConfig (/home/runner/work/_actions/github/codeql-action/71a8b35ff4c80fcfcd05bc1cd932fe3c08f943ca/lib/config-utils.js:577:41)
```
With this change, the error message is more comprehensible:
`queries must be an array, with each entry having a 'uses' property`
Handle other cases where the config is invalid.
henrymercer
approved these changes
Aug 23, 2022
henrymercer
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
Comment thread
CHANGELOG.md
Outdated
Co-authored-by: Henry Mercer <henrymercer@github.com>
aeisenberg
enabled auto-merge
August 23, 2022 17:06
6 tasks
4 tasks
This was referenced Dec 1, 2023
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.
Query-filters block:
Throws a more coherent error message when the query-filters block is not an array.
Queries block:
When someone creates an invalid queries entry in the codeql config
file, like this:
The error message is confusing, looking like this:
Error: Cannot use 'in' operator to search for 'uses' in ql/ql/src TypeError: Cannot use 'in' operator to search for 'uses' in ql/ql/src at loadConfig (/home/runner/work/_actions/github/codeql-action/71a8b35ff4c80fcfcd05bc1cd932fe3c08f943ca/lib/config-utils.js:577:41)With this change, the error message is more comprehensible:
queries must be an array, with each entry having a 'uses' property
Merge / deployment checklist