From b51db7f2de96245e6d6582647cf765bb3a038f84 Mon Sep 17 00:00:00 2001 From: Dominik Bamberger Date: Thu, 22 Jul 2021 19:21:16 +0200 Subject: [PATCH] Include packaging in 'Using custom queries with the CodeQL CLI'. --- ...ing-custom-queries-with-the-codeql-cli.rst | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst index 719ac3f3fe6..42143a8cfd1 100644 --- a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst @@ -47,7 +47,29 @@ For more information about these metadata properties, see ":ref:`Metadata for Co Metadata requirements may differ if you want to use your query with other applications. For more information, see ":ref:`Metadata for CodeQL queries ` - ." + ." + +Packaging custom QL queries +--------------------------- + +When writing your own queries, you can either just save them in a custom QL pack +directory or subsequently include the pack in a CodeQL package which you can +then upload to the GitHub Package Registry (GHPR). + +QL packs organize the files used in CodeQL analysis and can store queries, +library files, query suites, and important metadata. Their root directory must +contain a file named ``qlpack.yml``. Your custom queries should be saved in the +QL pack root, or its subdirectories. + +For each QL pack, the ``qlpack.yml`` file includes information that tells CodeQL +how to compile the queries, which other CodeQL packs and libraries the pack +depends on, and where to find query suite definitions. For more information +about what to include in this file, see ":ref:`About QL packs `." + +CodeQL packages are used to create, share, depend on, and run CodeQL queries and +libraries. You can publish your own CodeQL packages and download ones created by +others via the the GitHub Package Registry (GHPR). For further information see +":ref:`About CodeQL packs `." Contributing to the CodeQL repository -------------------------------------