hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-02-03 00:31:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Andrew Eisenberg <aeisenberg@github.com>
This commit is contained in:
Felicity Chapman
2021-07-26 22:38:25 +01:00
committed by GitHub
parent c6a9b029cf
commit 6c82c2c0c8
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/codeql/codeql-cli/about-codeql-packs.rst
View File

@@ -67,7 +67,7 @@ The following properties are supported in ``qlpack.yml`` files.
- All packs
- 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>`__.
* - ``dependencies``
- ``codeql/javascript-all: 1.2.3``
- ``codeql/javascript-all: ^1.2.3``
- Optional
- 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.
* - ``suites``

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

@@ -42,7 +42,7 @@ Modifying an existing QL pack to create a CodeQL pack
-----------------------------------------------------
If you already have a ``qlpack.yml`` file, you can edit it manually to convert it into a CodeQL pack.
#. 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.
#. 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.
#. In the ``qlpack.yml`` file, include a ``version`` property with a semver identifier, as well as an optional ``dependencies`` block.
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``.
codeql pack add <scope>/<name>@x.x.x <scope>/<other-name>
The version number is optional. If you leave off the version number, the latest version will be added.
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.
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.

2
docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst
View File

@@ -26,7 +26,7 @@ You can check and modify the configuration details of your CodeQL pack prior to
- query:
default-suite-file: default-queries.qls # a pointer to a query-suite in this pack
license: # optional, the license under which the pack is published
dependencies:
dependencies: # map from CodeQL pack name to version range
- ``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.
- 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.