Skip to content

Commit 6c82c2c

Browse files
Apply suggestions from code review
Co-authored-by: Andrew Eisenberg <[email protected]>
1 parent c6a9b02 commit 6c82c2c

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The following properties are supported in ``qlpack.yml`` files.
6767
- All packs
6868
- A version number for this CodeQL pack. This must be a valid semantic version that meets the `SemVer v2.0.0 specification <https://semver.org/spec/v2.0.0.html>`__.
6969
* - ``dependencies``
70-
- ``codeql/javascript-all: 1.2.3``
70+
- ``codeql/javascript-all: ^1.2.3``
7171
- Optional
7272
- The names of any CodeQL packs that this pack depends on, as a sequence. This gives the pack access to any libraries, database schema, and query suites defined in the dependency. Optionally a version for the dependency is specified.
7373
* - ``suites``

docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Modifying an existing QL pack to create a CodeQL pack
4242
-----------------------------------------------------
4343
If you already have a ``qlpack.yml`` file, you can edit it manually to convert it into a CodeQL pack.
4444

45-
#. Edit the ``name`` property so that it matches the format ``<scope>/<name>``, where ``<scope>`` is the name of the GitHub organization that you will publish to.
45+
#. Edit the ``name`` property so that it matches the format ``<scope>/<name>``, where ``<scope>`` is the name of the GitHub organization or user account that you will publish to.
4646
#. In the ``qlpack.yml`` file, include a ``version`` property with a semver identifier, as well as an optional ``dependencies`` block.
4747

4848
For more information about the properties, see ":ref:`About CodeQL packs <about-codeql-packs>`."
@@ -55,7 +55,7 @@ You can add dependencies on CodeQL packs using the command ``codeql pack add``.
5555

5656
codeql pack add <scope>/<name>@x.x.x <scope>/<other-name>
5757

58-
The version number is optional. If you leave off the version number, the latest version will be added.
58+
The version range is optional. If you leave off the version range, the latest version will be added. Otherwise, the latest version that satisfies the requested range will be added.
5959

6060
This command updates the ``qlpack.yml`` file with the requested dependencies and downloads them into the package cache. Please note that this command will reformat the file and remove all comments.
6161

docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can check and modify the configuration details of your CodeQL pack prior to
2626
- query:
2727
default-suite-file: default-queries.qls # a pointer to a query-suite in this pack
2828
license: # optional, the license under which the pack is published
29-
dependencies:
29+
dependencies: # map from CodeQL pack name to version range
3030
3131
- ``name:`` must follow the <scope>/<pack> format, where <scope> is the GitHub organization that you will publish to and <pack> is the name for the pack.
3232
- Only one of ``default-suite`` or ``default-suite-file`` is allowed. Both options define a default query suite to be run, the first by specifying queries directly in the `qlpack.yml` file and the second by specifying a query suite in the pack.

0 commit comments

Comments
 (0)