You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Working with CodeQL packs on GitHub Enterprise Server
77
77
------------------------------------------
78
78
79
79
.. pull-quote::
80
80
81
81
Note
82
82
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.
84
84
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.
88
88
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:
89
89
90
90
.. code-block:: yaml
91
91
92
92
registries:
93
93
- packages: '*'
94
-
url: https://containers.GHE_HOSTNAME/v2/
94
+
url: https://containers.GHE_HOSTNAME/v2/
95
95
- packages: 'codeql/*'
96
-
url: https://ghcr.io/v2/
96
+
url: https://ghcr.io/v2/
97
97
98
98
You can now use ``codeql pack publish``, ``codeql pack download``, and ``codeql database analyze`` to manage packs on GitHub Enterprise Server.
99
99
@@ -107,7 +107,7 @@ You can authenticate to the Container registry on GitHub.com in two ways:
107
107
1. Pass the ``--github-auth-stdin`` option to the CodeQL CLI, then supply a GitHub Apps token or personal access token via standard input.
108
108
2. Set the ``GITHUB_TOKEN`` environment variable to a GitHub Apps token or personal access token.
109
109
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:
111
111
112
112
1. Pass the ``--registries-auth-stdin`` option to the CodeQL CLI, then supply a registry authentication string via standard input.
113
113
2. Set the ``CODEQL_REGISTRIES_AUTH`` environment variable to a registry authentication string.
0 commit comments