Skip to content

Commit 376fea6

Browse files
committed
Clarify description of registries input
1 parent bf97a6d commit 376fea6

File tree

6 files changed

+12
-14
lines changed

6 files changed

+12
-14
lines changed

.github/workflows/__init-with-registries.yml

Lines changed: 3 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

init/action.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,20 @@ inputs:
1515
required: false
1616
registries:
1717
description: |
18+
Use this input only when you need to download CodeQL packages from another instance of GitHub. If you only need to download packages from this GitHub instance, use the token input instead.
19+
1820
A YAML string that defines the list of GitHub container registries to use for downloading packs. The string is in the following form (the | is required on the first line):
1921
2022
registries: |
2123
- url: https://containers.GHEHOSTNAME1/v2/
2224
packages:
2325
- my-company/*
2426
- my-company2/*
25-
token: ${{ secrets.GHEHOSTNAME1_TOKEN }}
27+
token: \$\{{ secrets.GHEHOSTNAME1_TOKEN }}
2628
2729
- url: https://ghcr.io/v2/
2830
packages: */*
29-
token: ${{ secrets.GHCR_TOKEN }}
31+
token: \$\{{ secrets.GHCR_TOKEN }}
3032
3133
The url property contains the URL to the container registry you want to connect to.
3234

lib/config-utils.test.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/config-utils.test.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pr-checks/checks/init-with-registries.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ steps:
1515
config-file: ./.github/codeql/codeql-config-registries.yml
1616
languages: javascript
1717
registries: |
18-
- url: "https://ghcr.io/v2/",
19-
packages: "*/*",
18+
- url: "https://ghcr.io/v2/"
19+
packages: "*/*"
2020
token: "${{ secrets.GITHUB_TOKEN }}"
2121
2222
env:

src/config-utils.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2296,7 +2296,7 @@ test("downloadPacks-with-registries", async (t) => {
22962296
t.deepEqual(process.env.GITHUB_TOKEN, sampleApiDetails.auth);
22972297
t.deepEqual(
22982298
process.env.CODEQL_REGISTRIES_AUTH,
2299-
"http://ghcr.io=not-a-token,https://containers.GHEHOSTNAME1/v2/=still-a-token"
2299+
"http://ghcr.io=not-a-token,https://containers.GHEHOSTNAME1/v2/=still-not-a-token"
23002300
);
23012301

23022302
// verify the config file contents were set correctly

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy