hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-01-28 05:42:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve links

Browse Source
This commit is contained in:
james
2021-11-08 11:18:41 +00:00
parent 5ea93d6447
commit c94bfc306a
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst
View File

@@ -219,13 +219,16 @@ alerts generated by the custom queries.
From CodeQL CLI 2.7.1 onwards, you can include markdown-rendered query help in SARIF files
by providing the ``--sarif-add-query-help`` option when running
``codeql database analyze``.
For more information, see `Configuring CodeQL CLI in your CI system <https://docs.github.com/en/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database>`
in the GitHub documentation.
You can write query help for custom queries directly in markdown file and save it alongside the
You can write query help for custom queries directly in a markdown file and save it alongside the
corresponding query. Alternatively, for consistency with the standard CodeQL queries,
you can write query help in the ``.qhelp`` format and convert it to markdown before
running the analysis. Query help written in ``.qhelp`` files can't be included in SARIF files,
and they can't be processed by code scanning. For more information, see
":doc:`Testing query help files <testing-query-help-files>`."
you can write query help in the ``.qhelp`` format. Query help written in ``.qhelp``
files can't be included in SARIF files, and they can't be processed by code
scanning so must be converted to markdown before running
the analysis. For more information, see ":doc:`Query help files <query-help-files>`"
and ":doc:`Testing query help files <testing-query-help-files>`."
Results
-------