Cockatrice/.github/workflows/vcpkg-cache-import.yml

name: Import vcpkg cache

# After a runner image update changes every port's ABI hash, the first master run
# rebuilds protobuf, openssl and abseil from source and saves them into the shared
# cache, where every later run can restore them.
#
# Only master pushes and the nightly schedule run on master are imported here: the
# collect step, keys.txt and the zip contents all come from the workflow run being
# imported, so importing from an unmerged pull request would let anyone who can push
# a branch — or a bot actor such as Dependabot, whose PRs are same-repo — promote
# arbitrary binaries into the scope that master and tag builds restore and link into
# signed releases. Forks build untrusted code and must never reach that scope either.
# A scheduled run is the default branch at the commit a master push already built, so
# it carries the same trust as a push.
#
# repository_dispatch is not used on purpose: it would also resolve to the default branch,
# but it counts as a low-trust trigger and may only write there when it declares a
# write-capable cache-mode, which puts it in the same position as workflow_run.

permissions:
  actions: write    # needed to save entries into the default branch's cache scope
  contents: read

on:
  workflow_run:
    workflows: ["Build Desktop"]
    types: [completed]

# Every import writes the same scopes, so let them queue instead of racing each other
concurrency:
  group: vcpkg-cache-import
  cancel-in-progress: false

jobs:
  list:
    name: List new vcpkg entries
    # Only a successful push to the default branch has archives worth importing.
    # Only code that landed on master may populate the scope master runs restore.
    # Bot actors are excluded on top: their runs must never promote binaries into
    # the shared scope even if they somehow target the default branch.
    if: >-
      github.event.workflow_run.conclusion == 'success' &&
      (github.event.workflow_run.event == 'push' || github.event.workflow_run.event == 'schedule') &&
      github.event.workflow_run.head_branch == 'master' &&
      github.event.workflow_run.head_repository.full_name == github.repository &&
      !endsWith(github.event.workflow_run.actor.login, '[bot]') &&
      !endsWith(github.event.workflow_run.triggering_actor.login, '[bot]')
    runs-on: ubuntu-slim    # https://github.com/actions/runner-images/blob/main/images/ubuntu-slim/ubuntu-slim-Readme.md
    # workflow_run is a low-trust trigger, so cache access is read-only by default even
    # though this run resolves to the default branch. Assert below that this took effect,
    # because a save under read-only access only warns and would import nothing silently.
    cache-mode: write
    outputs:
      entries: ${{ steps.scan.outputs.entries }}

    steps:
      - name: "Download new vcpkg entries"
        uses: actions/download-artifact@v8
        with:
          pattern: vcpkg-new-*
          path: incoming
          run-id: ${{ github.event.workflow_run.id }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

      - name: "Assert write access"
        shell: bash
        run: |
          if [[ $ACTIONS_CACHE_MODE != *write* ]]; then
            echo "::error::expected a write-capable cache, got '$ACTIONS_CACHE_MODE'"
            exit 1
          fi

      - name: "List cache entries"
        id: scan
        shell: bash
        working-directory: incoming
        run: |
          entries="$(find . -name keys.txt -type f -exec sh -c '
            for manifest; do
              artifact="$(basename "$(dirname "$manifest")")"
              while read -r key path; do
                printf "{\"artifact\": \"%s\", \"key\": \"%s\", \"path\": \"%s\"}\n" \
                  "$artifact" "$key" "$path"
              done <"$manifest"
            done
          ' _ {} +)"
          [[ -n $entries ]] || exit 0
          # Compact, because a multi line value cannot be written to GITHUB_OUTPUT
          entries="$(jq -cs '.' <<<"$entries")"
          echo "entries=$entries" >>"$GITHUB_OUTPUT"
          echo "::notice::importing $(jq length <<<"$entries") vcpkg entries"

  save:
    name: "Save ${{ matrix.entry.key }}"
    needs: list
    if: needs.list.outputs.entries
    runs-on: ubuntu-slim
    cache-mode: write
    strategy:
      # One job per archive, they run in parallel and each only uploads a single file
      fail-fast: false
      max-parallel: 20
      matrix:
        entry: ${{ fromJSON(needs.list.outputs.entries) }}

    steps:
      - name: "Download new vcpkg entries"
        uses: actions/download-artifact@v8
        with:
          pattern: ${{ matrix.entry.artifact }}
          path: incoming
          run-id: ${{ github.event.workflow_run.id }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

      - name: "Save vcpkg entry"
        uses: actions/cache/save@v6
        with:
          # The payload is a Windows or macOS archive while the upload runs on Linux, and
          # without this the entry would be stamped as a Linux cache that neither of them
          # is allowed to restore.
          enableCrossOsArchive: true
          key: ${{ matrix.entry.key }}
          path: incoming/${{ matrix.entry.path }}