Add comment about registry kinds

This commit is contained in:
Dave Bartolomeo 2024-11-01 14:00:48 -04:00
parent 4e764dc701
commit ca91b63a7d
2 changed files with 4 additions and 1 deletions

File diff suppressed because one or more lines are too long

View file

@ -66,6 +66,9 @@ export interface RegistryConfigNoCredentials {
packages: string[] | string;
// Kind of registry, either "github" or "docker". Default is "docker".
// "docker" refers specifically to the GitHub Container Registry, which is the usual way of sharing CodeQL packs.
// "github" refers to packs published as content in a GitHub repository. This kind of registry is used in scenarios
// where GHCR is not available, such as certain GHES environments.
kind?: "github" | "docker";
}