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

Add section on managing packs on GHES

Browse Source
This commit is contained in:
Henry Mercer
2022-06-15 16:42:32 -07:00
parent b16124d522
commit 5931ea4ab8
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -72,3 +72,21 @@ The ``analyze`` command will run the default suite of any specified CodeQL packs
::
codeql <database> analyze <scope>/<pack> <scope>/<other-pack>
Managing packs on GitHub Enterprise Server
------------------------------------------
By default, CodeQL will download packs from and publish packs to the GitHub.com Container registry.
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.
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.
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:
.. code-block:: yaml
registries:
- packages: '*'
url: https://containers.GHE_HOSTNAME/v2/
- packages: 'codeql/*'
url: https://ghcr.io/v2/
You can now use ``codeql pack publish``, ``codeql pack download``, and ``codeql database analyze`` to manage packs on GitHub Enterprise Server.