hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Address review comments

Browse Source
This commit is contained in:
Henry Mercer
2022-06-28 13:52:26 +01:00
parent 4733653939
commit a7bd2030b6
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -73,6 +73,6 @@ This command downloads all dependencies to the shared cache on the local disk.
Note
By default ``codeql pack install`` will install dependencies from the GitHub.com Container registry.
By default ``codeql pack install`` will install dependencies from the Container registry on GitHub.com.
You can install dependencies from a GitHub Enterprise Server Container registry by creating a ``qlconfig.yml`` file.
For more information, see ":doc:`Publishing and using CodeQL packs <publishing-and-using-codeql-packs>`."

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

@@ -76,10 +76,16 @@ The ``analyze`` command will run the default suite of any specified CodeQL packs
Managing packs on GitHub Enterprise Server
------------------------------------------
By default, CodeQL will download packs from and publish packs to the GitHub.com Container registry.
.. pull-quote::
Note
Managing packs on GitHub Enterprise Server is only available for GitHub Enterprise Server 3.6 and later.
By default, CodeQL will download packs from and publish packs to the Container registry on GitHub.com.
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:
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:
.. code-block:: yaml
@@ -96,7 +102,7 @@ Authenticating to GitHub Container registries
You can download a private pack or publish a pack by authenticating to the appropriate GitHub Container registry.
You can authenticate to the GitHub.com Container registry in two ways:
You can authenticate to the Container registry on GitHub.com in two ways:
1. Pass the ``--github-auth-stdin`` option to the CodeQL CLI, then supply a GitHub Apps token or personal access token via standard input.
2. Set the ``GITHUB_TOKEN`` environment variable to a GitHub Apps token or personal access token.