Include custom query help in analysis results - #804
cklin merged 1 commit into
Conversation
Sorry, something went wrong.
adityasharad
left a comment
There was a problem hiding this comment.
Code change looks good, some suggestions for change note and tests.
Sorry, something went wrong.
| ## [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?
| - 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) |
Sorry, something went wrong.
There was a problem hiding this comment.
That is much better. I applied it to the commit.
Sorry, something went wrong.
| 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".
Sorry, something went wrong.
There was a problem hiding this comment.
Thank you for the suggestion. I updated the failure message.
Sorry, something went wrong.
| 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.
should be present
Sorry, something went wrong.
There was a problem hiding this comment.
Thank you for the suggestion. I updated the failure message.
Sorry, something went wrong.
Merge / deployment checklist