Merge pull request #2652 from github/mbg/private-registries/feed-outputs

Add private registry URLs as output to the `start-proxy` Action

.github/workflows/__start-proxy.yml

@@ -0,0 +1,80 @@
+# Warning: This file is generated automatically, and should not be modified.
+# Instead, please modify the template in the pr-checks directory and run:
+#     (cd pr-checks; pip install ruamel.yaml@0.17.31 && python3 sync.py)
+# to regenerate this file.
+
+name: PR Check - Start proxy
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  GO111MODULE: auto
+on:
+  push:
+    branches:
+      - main
+      - releases/v*
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+  schedule:
+    - cron: '0 5 * * *'
+  workflow_dispatch: {}
+jobs:
+  start-proxy:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            version: linked
+          - os: macos-latest
+            version: linked
+          - os: windows-latest
+            version: linked
+    name: Start proxy
+    permissions:
+      contents: read
+      security-events: write
+    timeout-minutes: 45
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Setup Python on macOS
+        uses: actions/setup-python@v5
+        if: runner.os == 'macOS' && matrix.version == 'stable-v2.14.6'
+        with:
+          python-version: '3.11'
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Prepare test
+        id: prepare-test
+        uses: ./.github/actions/prepare-test
+        with:
+          version: ${{ matrix.version }}
+          use-all-platform-bundle: 'false'
+          setup-kotlin: 'true'
+      - uses: ./../action/init
+        with:
+          languages: csharp
+          tools: ${{ steps.prepare-test.outputs.tools-url }}
+
+      - name: Setup proxy for registries
+        id: proxy
+        uses: ./../action/start-proxy
+        with:
+          registry_secrets: '[{ "type": "nuget_feed", "url": "https://api.nuget.org/v3/index.json"
+            }]'
+
+      - name: Print proxy outputs
+        run: |
+          echo "${{ steps.proxy.outputs.proxy_host }}"
+          echo "${{ steps.proxy.outputs.proxy_port }}"
+          echo "${{ steps.proxy.outputs.proxy_urls }}"
+
+      - name: Fail if proxy outputs are not set
+        if: (!steps.proxy.outputs.proxy_host) || (!steps.proxy.outputs.proxy_port)
+          || (!steps.proxy.outputs.proxy_ca_certificate) || (!steps.proxy.outputs.proxy_urls)
+        run: exit 1
+    env:
+      CODEQL_ACTION_TEST_MODE: true

lib/start-proxy-action.js

@@ -152,6 +152,10 @@ async function startProxy(binPath, config, logFilePath, logger) {
         core.setOutput("proxy_host", host);
         core.setOutput("proxy_port", port.toString());
         core.setOutput("proxy_ca_certificate", config.ca.cert);
+        const registry_urls = config.all_credentials
+            .filter((credential) => credential.url !== undefined)
+            .map((credential) => credential.url);
+        core.setOutput("proxy_urls", JSON.stringify(registry_urls));
     }
     catch (error) {
         core.setFailed(`start-proxy action failed: ${util.getErrorMessage(error)}`);

pr-checks/.gitignore

@@ -0,0 +1 @@
+env

pr-checks/checks/start-proxy.yml

@@ -0,0 +1,25 @@
+name: "Start proxy"
+description: "Tests that the proxy can be initialised on all platforms"
+operatingSystems: ["ubuntu", "macos", "windows"]
+versions: ["linked"]
+steps:
+  - uses: ./../action/init
+    with:
+      languages: csharp
+      tools: ${{ steps.prepare-test.outputs.tools-url }}
+
+  - name: Setup proxy for registries
+    id: proxy
+    uses: ./../action/start-proxy
+    with:
+      registry_secrets: '[{ "type": "nuget_feed", "url": "https://api.nuget.org/v3/index.json" }]'
+
+  - name: Print proxy outputs
+    run: |
+      echo "${{ steps.proxy.outputs.proxy_host }}"
+      echo "${{ steps.proxy.outputs.proxy_port }}"
+      echo "${{ steps.proxy.outputs.proxy_urls }}"
+
+  - name: Fail if proxy outputs are not set
+    if: (!steps.proxy.outputs.proxy_host) || (!steps.proxy.outputs.proxy_port) || (!steps.proxy.outputs.proxy_ca_certificate) || (!steps.proxy.outputs.proxy_urls)
+    run: exit 1

src/start-proxy-action.ts

@@ -171,6 +171,11 @@ async function startProxy(
     core.setOutput("proxy_host", host);
     core.setOutput("proxy_port", port.toString());
     core.setOutput("proxy_ca_certificate", config.ca.cert);
+
+    const registry_urls = config.all_credentials
+      .filter((credential) => credential.url !== undefined)
+      .map((credential) => credential.url);
+    core.setOutput("proxy_urls", JSON.stringify(registry_urls));
   } catch (error) {
     core.setFailed(`start-proxy action failed: ${util.getErrorMessage(error)}`);
   }

start-proxy/action.yml

@@ -23,6 +23,8 @@ outputs:
     description: The port of the proxy
   proxy_ca_certificate:
     description: The proxy's internal CA certificate in PEM format
+  proxy_urls:
+    description: The URLs of the configured registries, as a JSON array.
 runs:
   using: node20
   main: "../lib/start-proxy-action.js"