Add new option to database analyze tutorial#7056
Merged
Merged
Conversation
Contributor
Author
|
BONUS: In https://codeql.github.com/docs/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow/ I spotted a weird empty code block and am incorrectly rendered link. Fixed in dfe77f8. |
Contributor
Author
|
@adityasharad: please can I get a quick technical review? |
adityasharad
approved these changes
Nov 8, 2021
ethanpalm
approved these changes
Nov 8, 2021
ethanpalm
left a comment
Contributor
There was a problem hiding this comment.
This looks good from a docs point of view 👍🏼
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.
In the upcoming release of the CodeQL CLI there's a new option you can supply to the
database analyzecommand to include query help files for custom queries in the SARIF file produced during the analysis. The query help must be in markdown, not .qhelp format. There'll be an accompanying change in the GitHub docs to briefly mention how to enable this feature for users running CodeQL code scanning on 3rd party CI/CD systems. However, much of new information is aimed at custom query writers so the bulk of the detail is in this PR.