From 228e4938df0605b8dc42054a732a84a159a82d50 Mon Sep 17 00:00:00 2001 From: Dominik Bamberger Date: Mon, 26 Jul 2021 09:41:05 +0200 Subject: [PATCH] Add description metadata example. --- docs/codeql/codeql-cli/about-codql-packs.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/codeql/codeql-cli/about-codql-packs.rst b/docs/codeql/codeql-cli/about-codql-packs.rst index 7963761fbb9..ac1647152e1 100644 --- a/docs/codeql/codeql-cli/about-codql-packs.rst +++ b/docs/codeql/codeql-cli/about-codql-packs.rst @@ -96,3 +96,6 @@ The following properties are supported in ``qlpack.yml`` files. * - ``licenses`` - ``(LGPL-2.1 AND MIT)`` - Metadata that will be displayed on the packaging search page in the packages section of the organization that a CodeQL pack is published to. + * - ``description`` + - ``Human-readable description of the software packaged in the image.`` + - Metadata that will be displayed on the packaging search page in the packages section of the organization that a CodeQL pack is published to.