Skip to content

Commit 4dcec2b

Browse files
henrymercerfelicitymayaeisenberg
authored
Apply suggestions from code review
Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: Andrew Eisenberg <[email protected]>
1 parent a7bd203 commit 4dcec2b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,27 +73,27 @@ The ``analyze`` command will run the default suite of any specified CodeQL packs
7373

7474
codeql <database> analyze <scope>/<pack> <scope>/<other-pack>
7575

76-
Managing packs on GitHub Enterprise Server
76+
Working with CodeQL packs on GitHub Enterprise Server
7777
------------------------------------------
7878

7979
.. pull-quote::
8080

8181
Note
8282

83-
Managing packs on GitHub Enterprise Server is only available for GitHub Enterprise Server 3.6 and later.
83+
The Container registry for GitHub Enterprise Server supports CodeQL query packs from GitHub Enterprise Server 3.6 onward.
8484

85-
By default, CodeQL will download packs from and publish packs to the Container registry on GitHub.com.
86-
You can manage packs on GitHub Enterprise Server 3.6 and later by creating a ``qlconfig.yml`` file to tell CodeQL which Container registry to use for each pack.
87-
Create the ``~/.codeql/qlconfig.yml`` file using your preferred text editor, and add entries to specify which registry to use for each pack name pattern.
85+
By default, the CodeQL CLI expects to download CodeQL packs from and publish packs to the Container registry on GitHub.com. However, you can also work with CodeQL packs in a Container registry on GitHub Enterprise Server 3.6, and later, by creating a ``qlconfig.yml`` file to tell the CLI which Container registry to use for each pack.
86+
87+
Create a ``~/.codeql/qlconfig.yml`` file using your preferred text editor, and add entries to specify which registry to use for one or more package name patterns.
8888
For example, the following ``qlconfig.yml`` file associates all packs with the Container registry for the GitHub Enterprise Server at ``GHE_HOSTNAME``, except packs matching ``codeql/*``, which are associated with the Container registry on GitHub.com:
8989

9090
.. code-block:: yaml
9191
9292
registries:
9393
- packages: '*'
94-
url: https://containers.GHE_HOSTNAME/v2/
94+
url: https://containers.GHE_HOSTNAME/v2/
9595
- packages: 'codeql/*'
96-
url: https://ghcr.io/v2/
96+
url: https://ghcr.io/v2/
9797
9898
You can now use ``codeql pack publish``, ``codeql pack download``, and ``codeql database analyze`` to manage packs on GitHub Enterprise Server.
9999

@@ -107,7 +107,7 @@ You can authenticate to the Container registry on GitHub.com in two ways:
107107
1. Pass the ``--github-auth-stdin`` option to the CodeQL CLI, then supply a GitHub Apps token or personal access token via standard input.
108108
2. Set the ``GITHUB_TOKEN`` environment variable to a GitHub Apps token or personal access token.
109109

110-
Similarly, you can authenticate to a GHES Container registry, or authenticate to multiple registries simultaneously (for example to download or analyze private packs from multiple registries) in two ways:
110+
Similarly, you can authenticate to a GHES Container registry, or authenticate to multiple registries simultaneously (for example, to download or run private packs from multiple registries) in two ways:
111111

112112
1. Pass the ``--registries-auth-stdin`` option to the CodeQL CLI, then supply a registry authentication string via standard input.
113113
2. Set the ``CODEQL_REGISTRIES_AUTH`` environment variable to a registry authentication string.

0 commit comments

Comments
 (0)