Clarify description of registries input

github · Sep 6, 2022 · 376fea6 · 376fea6
1 parent bf97a6d
commit 376fea6
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 14 deletions.
diff --git a/.github/workflows/__init-with-registries.yml b/.github/workflows/__init-with-registries.yml
diff --git a/init/action.yml b/init/action.yml
@@ -15,18 +15,20 @@ inputs:
     required: false
   registries:
     description: |
+      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.
+
       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):
 
       registries: |
           - url: https://containers.GHEHOSTNAME1/v2/
             packages:
               - my-company/*
               - my-company2/*
-            token: ${{ secrets.GHEHOSTNAME1_TOKEN }}
+            token: \$\{{ secrets.GHEHOSTNAME1_TOKEN }}
 
           - url: https://ghcr.io/v2/
             packages: */*
-            token: ${{ secrets.GHCR_TOKEN }}
+            token: \$\{{ secrets.GHCR_TOKEN }}
 
       The url property contains the URL to the container registry you want to connect to.
 

diff --git a/lib/config-utils.test.js b/lib/config-utils.test.js
diff --git a/lib/config-utils.test.js.map b/lib/config-utils.test.js.map
diff --git a/pr-checks/checks/init-with-registries.yml b/pr-checks/checks/init-with-registries.yml
@@ -15,8 +15,8 @@ steps:
       config-file: ./.github/codeql/codeql-config-registries.yml
       languages: javascript
       registries: |
-          - url: "https://ghcr.io/v2/",
-            packages: "*/*",
+          - url: "https://ghcr.io/v2/"
+            packages: "*/*"
             token: "${{ secrets.GITHUB_TOKEN }}"
 
     env:

diff --git a/src/config-utils.test.ts b/src/config-utils.test.ts
@@ -2296,7 +2296,7 @@ test("downloadPacks-with-registries", async (t) => {
       t.deepEqual(process.env.GITHUB_TOKEN, sampleApiDetails.auth);
       t.deepEqual(
         process.env.CODEQL_REGISTRIES_AUTH,
-        "http://ghcr.io=not-a-token,https://containers.GHEHOSTNAME1/v2/=still-a-token"
+        "http://ghcr.io=not-a-token,https://containers.GHEHOSTNAME1/v2/=still-not-a-token"
       );
 
       // verify the config file contents were set correctly