Skip to content

Commit 5931ea4

Browse files
committed
Add section on managing packs on GHES
1 parent b16124d commit 5931ea4

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,21 @@ The ``analyze`` command will run the default suite of any specified CodeQL packs
7272
::
7373

7474
codeql <database> analyze <scope>/<pack> <scope>/<other-pack>
75+
76+
Managing packs on GitHub Enterprise Server
77+
------------------------------------------
78+
79+
By default, CodeQL will download packs from and publish packs to the GitHub.com Container registry.
80+
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.
81+
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.
82+
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 GitHub.com Container registry:
83+
84+
.. code-block:: yaml
85+
86+
registries:
87+
- packages: '*'
88+
url: https://containers.GHE_HOSTNAME/v2/
89+
- packages: 'codeql/*'
90+
url: https://ghcr.io/v2/
91+
92+
You can now use ``codeql pack publish``, ``codeql pack download``, and ``codeql database analyze`` to manage packs on GitHub Enterprise Server.

0 commit comments

Comments
 (0)