@@ -66,7 +66,7 @@ You can also specify:
6666- ``--sarif-add-query-help ``: (supported in version 2.7.1 onwards) adds any custom query help written
6767 in markdown to SARIF files (v2.1.0 or later) generated by the analysis. Query help stored in ``.qhelp `` files must be
6868 converted to ``.md `` before running the analysis. For further information,
69- see ":doc : `Including query help for custom CodeQL queries in SARIF files <testing -query-help-files >`."
69+ see ":ref : `Including query help for custom CodeQL queries in SARIF files <including -query-help-for-custom-codeql-queries-in-sarif -files >`."
7070
7171- .. include:: ../reusables/threads-query-execution.rst
7272
@@ -211,15 +211,21 @@ supported by CodeQL.
211211Including query help for custom CodeQL queries in SARIF files
212212~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213213
214- Code scanning does not process ``.qhelp `` files for custom CodeQL queries, so to show
215- query help for custom queries in the code scanning UI you must include markdown-rendered query help
216- in SARIF files generated during an analysis.
214+ If you use the CodeQL CLI to to run code scanning analyses on third party CI/CD systems,
215+ you can include the query help for your custom queries in SARIF files generated during an analysis.
216+ After uploading the SARIF file to GitHub, the query help is shown in the code scanning UI for any
217+ alerts generated by the custom queries.
217218
218- For CodeQL CLI 2.7.1 onwards, you can include markdown-rendered query help in SARIF files
219+ From CodeQL CLI 2.7.1 onwards, you can include markdown-rendered query help in SARIF files
219220by providing the ``--sarif-add-query-help `` option when running
220- ``codeql database analyze ``. Query help written in ``.qhelp `` files cannot be include in SARIF files,
221- so must be converted to markdown before running the analysis. For more information, see
222- ":ref: `Testing query help files <testing-query-help-files >`."
221+ ``codeql database analyze ``.
222+
223+ You can write query help for custom queries directly in markdown file and save it alongside the
224+ corresponding query. Alternatively, for consistency with the standard CodeQL queries,
225+ you can write query help in the ``.qhelp `` format and convert it to markdown before
226+ running the analysis. Query help written in ``.qhelp `` files can't be included in SARIF files,
227+ and they can't be processed by code scanning. For more information, see
228+ ":doc: `Testing query help files <testing-query-help-files >`."
223229
224230Results
225231-------
0 commit comments