Include custom query help in analysis results #804
Merged
Conversation
This file contains 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
cklin
force-pushed
the
cklin/include-custom-query-help
branch
from
ffd03a1
to
cf59610
Compare
cklin
force-pushed
the
cklin/include-custom-query-help
branch
from
cf59610
to
eef9c63
Compare
adityasharad
reviewed
Nov 2, 2021
CHANGELOG.md
Outdated
| @@ -3,6 +3,7 @@ | |||
| ## [UNRELEASED] | |||
|
|
|||
| - The `init` step of the Action now supports `ram` and `threads` inputs to limit resource use of CodeQL extractors. These inputs also serve as defaults to the subsequent `analyze` step, which finalizes the database and executes queries. [#738](https://github.com/github/codeql-action/pull/738) | |||
| - When used with CodeQL bundle 2.7.1 or above, the action now includes custom query help (if it exists in Markdown files that have the same paths as the query files but with `.md` extension instead of `.ql`) in analysis results. [#804](https://github.com/github/codeql-action/pull/804) | |||
There was a problem hiding this comment.
How's this?
Suggested change
| - When used with CodeQL bundle 2.7.1 or above, the action now includes custom query help (if it exists in Markdown files that have the same paths as the query files but with `.md` extension instead of `.ql`) in analysis results. [#804](https://github.com/github/codeql-action/pull/804) | |
| - When used with CodeQL 2.7.1 or above, the Action now includes custom query help in the analysis results uploaded to GitHub code scanning, if available. To add help text for a custom query, create a Markdown file next to the `.ql` file containing the query, using the same base name but the file extension `.md`. [#804](https://github.com/github/codeql-action/pull/804) |
There was a problem hiding this comment.
That is much better. I applied it to the commit.
cklin
force-pushed
the
cklin/include-custom-query-help
branch
3 times, most recently
from
71b4936
to
01d7f67
Compare
adityasharad
approved these changes
Nov 3, 2021
src/codeql.test.ts
Outdated
| await codeqlObject.databaseInterpretResults("", [], "", "", "", ""); | ||
| t.false( | ||
| runnerConstructorStub.firstCall.args[1].includes("--sarif-add-query-help"), | ||
| "--sarif-add-query-help is present" |
There was a problem hiding this comment.
This is the failure message? Perhaps "should not be present".
There was a problem hiding this comment.
Thank you for the suggestion. I updated the failure message.
src/codeql.test.ts
Outdated
| await codeqlObject.databaseInterpretResults("", [], "", "", "", ""); | ||
| t.true( | ||
| runnerConstructorStub.firstCall.args[1].includes("--sarif-add-query-help"), | ||
| "--sarif-add-query-help is present" |
There was a problem hiding this comment.
Thank you for the suggestion. I updated the failure message.
cklin
force-pushed
the
cklin/include-custom-query-help
branch
from
01d7f67
to
9a44540
Compare
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.
Merge / deployment checklist