Skip to content

Commit 9e6e37a

Browse files
committed
Add reference to codeql-pack.lock.yml in test packs
1 parent 353b50b commit 9e6e37a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/codeql/codeql-cli/about-codeql-packs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `CodeQL repository <https://github.com/github/codeql>`__ contains source fil
2323
CodeQL pack structure
2424
---------------------
2525

26-
A CodeQL pack must contain a file called ``qlpack.yml`` in its root directory. In the ``qlpack.yml`` file, the ``name:`` field must have a value that follows the format of ``<scope>/<pack>``, where ``<scope>`` is the GitHub organization or user account that the pack will be published to and ``<pack>`` is the name of the pack. Additionally, query packs contain a ``codeql-pack.lock.yml`` file that contains the resolved dependencies of the pack. This file is generated during a call to the ``codeql pack install`` command, is not meant to be edited by hand, and should be added to your version control system.
26+
A CodeQL pack must contain a file called ``qlpack.yml`` in its root directory. In the ``qlpack.yml`` file, the ``name:`` field must have a value that follows the format of ``<scope>/<pack>``, where ``<scope>`` is the GitHub organization or user account that the pack will be published to and ``<pack>`` is the name of the pack. Additionally, query packs and library packs with CodeQL tests contain a ``codeql-pack.lock.yml`` file that contains the resolved dependencies of the pack. This file is generated during a call to the ``codeql pack install`` command, is not meant to be edited by hand, and should be added to your version control system.
2727

2828
The other files and directories within the pack should be logically organized. For example, typically:
2929

0 commit comments

Comments
 (0)