release.yml

# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist
#
# Copyright 2022-2024, axodotdev
# SPDX-License-Identifier: MIT or Apache-2.0
#
# CI that:
#
# * checks for a Git Tag that looks like a release
# * builds artifacts with dist (archives, installers, hashes)
# * uploads those artifacts to temporary workflow zip
# * on success, uploads the artifacts to a GitHub Release
#
# Note that the GitHub Release will be created with a generated
# title/body based on your changelogs.

name: Release
permissions:
  "contents": "write"
  "pull-requests": "read"

# This task will run whenever you push a git tag that looks like a version
# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc.
# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where
# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION
# must be a Cargo-style SemVer Version (must have at least major.minor.patch).
#
# If PACKAGE_NAME is specified, then the announcement will be for that
# package (erroring out if it doesn't have the given version or isn't dist-able).
#
# If PACKAGE_NAME isn't specified, then the announcement will be for all
# (dist-able) packages in the workspace with that version (this mode is
# intended for workspaces with only one dist-able package, or with all dist-able
# packages versioned/released in lockstep).
#
# If you push multiple tags at once, separate instances of this workflow will
# spin up, creating an independent announcement for each one. However, GitHub
# will hard limit this to 3 tags per commit, as it will assume more tags is a
# mistake.
#
# If there's a prerelease-style suffix to the version, then the release(s)
# will be marked as a prerelease.
on:
  pull_request:
  push:
    tags:
      - '**[0-9]+.[0-9]+.[0-9]+*'

jobs:
  # Run 'dist plan' (or host) to determine what tasks we need to do
  plan:
    runs-on: "ubuntu-22.04"
    outputs:
      val: ${{ steps.plan.outputs.manifest }}
      tag: ${{ !github.event.pull_request && github.ref_name || '' }}
      tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }}
      publishing: ${{ !github.event.pull_request }}
    env:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
          submodules: recursive
      - name: Install dist
        # we specify bash to get pipefail; it guards against the `curl` command
        # failing. otherwise `sh` won't catch that `curl` returned non-0
        shell: bash
        run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.31.0/cargo-dist-installer.sh | sh"
      - name: Cache dist
        uses: actions/upload-artifact@v7
        with:
          name: cargo-dist-cache
          path: ~/.cargo/bin/dist
      # sure would be cool if github gave us proper conditionals...
      # so here's a doubly-nested ternary-via-truthiness to try to provide the best possible
      # functionality based on whether this is a pull_request, and whether it's from a fork.
      # (PRs run on the *source* but secrets are usually on the *target* -- that's *good*
      # but also really annoying to build CI around when it needs secrets to work right.)
      - id: plan
        run: |
          dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json
          echo "dist ran successfully"
          cat plan-dist-manifest.json
          echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT"
      - name: "Upload dist-manifest.json"
        uses: actions/upload-artifact@v7
        with:
          name: artifacts-plan-dist-manifest
          path: plan-dist-manifest.json

  # Build and packages all the platform-specific things
  build-local-artifacts:
    name: build-local-artifacts (${{ join(matrix.targets, ', ') }})
    # Let the initial task tell us to not run (currently very blunt)
    needs:
      - plan
    if: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix.include != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }}
    strategy:
      fail-fast: false
      # Target platforms/runners are computed by dist in create-release.
      # Each member of the matrix has the following arguments:
      #
      # - runner: the github runner
      # - dist-args: cli flags to pass to dist
      # - install-dist: expression to run to install dist on the runner
      #
      # Typically there will be:
      # - 1 "global" task that builds universal installers
      # - N "local" tasks that build each platform's binaries and platform-specific installers
      matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }}
    runs-on: ${{ matrix.runner }}
    container: ${{ matrix.container && matrix.container.image || null }}
    env:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json
    permissions:
      "attestations": "write"
      "contents": "read"
      "id-token": "write"
    steps:
      - name: enable windows longpaths
        run: |
          git config --global core.longpaths true
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
          submodules: recursive
      - name: Install Rust non-interactively if not already installed
        if: ${{ matrix.container }}
        run: |
          if ! command -v cargo > /dev/null 2>&1; then
            curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
            echo "$HOME/.cargo/bin" >> $GITHUB_PATH
          fi
      - name: Install dist
        run: ${{ matrix.install_dist.run }}
      # Get the dist-manifest
      - name: Fetch local artifacts
        uses: actions/download-artifact@v8
        with:
          pattern: artifacts-*
          path: target/distrib/
          merge-multiple: true
      - name: Install dependencies
        run: |
          ${{ matrix.packages_install }}
      - name: Build artifacts
        run: |
          # Actually do builds and make zips and whatnot
          dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json
          echo "dist ran successfully"
      - name: Attest
        uses: actions/attest-build-provenance@v4
        with:
          subject-path: "target/distrib/*${{ join(matrix.targets, ', ') }}*"
      - id: cargo-dist
        name: Post-build
        # We force bash here just because github makes it really hard to get values up
        # to "real" actions without writing to env-vars, and writing to env-vars has
        # inconsistent syntax between shell and powershell.
        shell: bash
        run: |
          # Parse out what we just built and upload it to scratch storage
          echo "paths<<EOF" >> "$GITHUB_OUTPUT"
          dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT"
          echo "EOF" >> "$GITHUB_OUTPUT"

          cp dist-manifest.json "$BUILD_MANIFEST_NAME"
      - name: "Upload artifacts"
        uses: actions/upload-artifact@v7
        with:
          name: artifacts-build-local-${{ join(matrix.targets, '_') }}
          path: |
            ${{ steps.cargo-dist.outputs.paths }}
            ${{ env.BUILD_MANIFEST_NAME }}

  # Build and package all the platform-agnostic(ish) things
  build-global-artifacts:
    needs:
      - plan
      - build-local-artifacts
    runs-on: "ubuntu-22.04"
    env:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
          submodules: recursive
      - name: Install cached dist
        uses: actions/download-artifact@v8
        with:
          name: cargo-dist-cache
          path: ~/.cargo/bin/
      - run: chmod +x ~/.cargo/bin/dist
      # Get all the local artifacts for the global tasks to use (for e.g. checksums)
      - name: Fetch local artifacts
        uses: actions/download-artifact@v8
        with:
          pattern: artifacts-*
          path: target/distrib/
          merge-multiple: true
      - id: cargo-dist
        shell: bash
        run: |
          dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json
          echo "dist ran successfully"

          # Parse out what we just built and upload it to scratch storage
          echo "paths<<EOF" >> "$GITHUB_OUTPUT"
          jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
          echo "EOF" >> "$GITHUB_OUTPUT"

          cp dist-manifest.json "$BUILD_MANIFEST_NAME"
      - name: "Upload artifacts"
        uses: actions/upload-artifact@v7
        with:
          name: artifacts-build-global
          path: |
            ${{ steps.cargo-dist.outputs.paths }}
            ${{ env.BUILD_MANIFEST_NAME }}
  # Determines if we should publish/announce
  host:
    needs:
      - plan
      - build-local-artifacts
      - build-global-artifacts
    # Only run if we're "publishing", and only if plan, local and global didn't fail (skipped is fine)
    if: ${{ always() && needs.plan.result == 'success' && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }}
    env:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    runs-on: "ubuntu-22.04"
    outputs:
      val: ${{ steps.host.outputs.manifest }}
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
          submodules: recursive
      - name: Install cached dist
        uses: actions/download-artifact@v8
        with:
          name: cargo-dist-cache
          path: ~/.cargo/bin/
      - run: chmod +x ~/.cargo/bin/dist
      # Fetch artifacts from scratch-storage
      - name: Fetch artifacts
        uses: actions/download-artifact@v8
        with:
          pattern: artifacts-*
          path: target/distrib/
          merge-multiple: true
      - id: host
        shell: bash
        run: |
          dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json
          echo "artifacts uploaded and released successfully"
          cat dist-manifest.json
          echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT"
      - name: "Upload dist-manifest.json"
        uses: actions/upload-artifact@v7
        with:
          # Overwrite the previous copy
          name: artifacts-dist-manifest
          path: dist-manifest.json
      # Create a GitHub Release while uploading all files to it
      - name: "Download GitHub Artifacts"
        uses: actions/download-artifact@v8
        with:
          pattern: artifacts-*
          path: artifacts
          merge-multiple: true
      - name: Cleanup
        run: |
          # Remove the granular manifests
          rm -f artifacts/*-dist-manifest.json
      - name: Create GitHub Release
        env:
          PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}"
          ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}"
          ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}"
          RELEASE_COMMIT: "${{ github.sha }}"
        run: |
          # Write and read notes from a file to avoid quoting breaking things
          echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt

          gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/*

  publish-npm-platforms:
    name: Publish CLI platform packages to npm
    needs:
      - host
    if: ${{ always() && needs.host.result == 'success' }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
      - uses: actions/setup-node@v6
        with:
          node-version: 24
          registry-url: https://registry.npmjs.org
          package-manager-cache: false
      # The same archives the release serves, so the npm CLI and the shell
      # installers hand out byte-identical binaries.
      - name: Fetch dist artifacts
        uses: actions/download-artifact@v8
        with:
          pattern: artifacts-*
          path: target/distrib/
          merge-multiple: true
      - name: Verify tag and package versions
        working-directory: packages/deckprobe-js
        shell: bash
        run: |
          package_version="$(node -p "require('./package.json').version")"
          tag_version="${GITHUB_REF_NAME#v}"
          if [[ "$package_version" != "$tag_version" ]]; then
            echo "npm package version $package_version does not match tag $GITHUB_REF_NAME" >&2
            exit 1
          fi
          node ./scripts/check-version.mjs
      - name: Build platform packages
        working-directory: packages/deckprobe-js
        run: node ./scripts/build-platform-packages.mjs --artifacts ../../target/distrib --out npm
      - name: Publish platform packages
        working-directory: packages/deckprobe-js
        shell: bash
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
        run: |
          package_version="$(node -p "require('./package.json').version")"
          publish_tag=latest
          if [[ "$package_version" == *-* ]]; then
            publish_tag=next
          fi
          for directory in npm/*/; do
            name="$(node -p "require('./${directory}package.json').name")"
            # Publishing eight packages multiplies the failure surface, so make
            # a rerun after a partial failure safe instead of fatal.
            if npm view "$name@$package_version" version >/dev/null 2>&1; then
              echo "$name@$package_version is already published; skipping"
              continue
            fi
            npm publish "$directory" --access public --provenance --tag "$publish_tag"
          done

  publish-npm:
    name: Publish CLI and Browser SDK to npm
    needs:
      - host
      # The main package declares the platform packages as optional
      # dependencies. Publishing it first would ship a version whose CLI cannot
      # resolve a binary until the rest land.
      - publish-npm-platforms
    if: ${{ always() && needs.host.result == 'success' && needs.publish-npm-platforms.result == 'success' }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: wasm32-unknown-unknown
      - uses: actions/setup-node@v6
        with:
          node-version: 24
          registry-url: https://registry.npmjs.org
          package-manager-cache: false
      - name: Install JavaScript dependencies
        working-directory: packages/deckprobe-js
        run: npm ci
      - name: Install Chromium
        working-directory: packages/deckprobe-js
        run: npx playwright install --with-deps chromium
      - name: Build the native CLI the launcher wraps
        run: cargo build --locked --release -p deckprobe
      - name: Build and test CLI and Browser SDK
        working-directory: packages/deckprobe-js
        run: |
          npm run build
          # Node/CLI parity depends on private fixtures enforced by the
          # promotion gate; the public repository intentionally excludes them.
          npm run test:public
          npm audit --audit-level=high
          npm pack --dry-run --json
      - name: Verify tag and package versions
        working-directory: packages/deckprobe-js
        shell: bash
        run: |
          package_version="$(node -p "require('./package.json').version")"
          tag_version="${GITHUB_REF_NAME#v}"
          if [[ "$package_version" != "$tag_version" ]]; then
            echo "npm package version $package_version does not match tag $GITHUB_REF_NAME" >&2
            exit 1
          fi
      - name: Publish Browser SDK
        working-directory: packages/deckprobe-js
        shell: bash
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
        run: |
          package_version="$(node -p "require('./package.json').version")"
          publish_tag=latest
          if [[ "$package_version" == *-* ]]; then
            publish_tag=next
          fi
          # Publish the exact archive whose contents passed the pack gate. This
          # prevents a source-only package from being accepted when dist/ or
          # wasm/ was absent from the working tree.
          rm -f ./*.tgz
          npm pack --silent
          tarball="deckflow-deckprobe-${package_version}.tgz"
          # List once into a variable. Piping tar into `grep -q` makes grep exit
          # on the first match, GNU tar then dies on EPIPE, and `pipefail` turns
          # that into a false "missing" verdict for a file that is present.
          tarball_contents="$(tar -tzf "$tarball")"
          for required in \
            package/dist/index.js \
            package/dist/index.node.js \
            package/wasm/deckprobe_wasm.js \
            package/wasm/deckprobe_wasm_bg.wasm; do
            if ! grep -Fxq "$required" <<<"$tarball_contents"; then
              echo "$tarball is missing $required" >&2
              exit 1
            fi
          done
          npm publish "$tarball" --access public --provenance --tag "$publish_tag"

  # The release job verifies a locally packed tarball. That cannot catch a
  # package that reaches the registry incomplete, which is exactly how 2.3.0
  # shipped without dist/ and wasm/ while every pre-publish gate passed. Install
  # the published version from the public registry in a clean directory and
  # exercise it the way a consumer would.
  verify-published:
    name: Verify the published npm package
    needs:
      - plan
      - publish-npm
    if: ${{ always() && needs.publish-npm.result == 'success' }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/setup-node@v6
        with:
          node-version: 24
          registry-url: https://registry.npmjs.org
      - name: Verify the registry artifact and run it as a consumer
        shell: bash
        env:
          RELEASE_TAG: ${{ needs.plan.outputs.tag }}
        run: |
          version="${RELEASE_TAG#v}"
          package="@deckflow/deckprobe@${version}"

          # npm publishes are not immediately readable. Retry, then fail loudly.
          for attempt in $(seq 1 15); do
            if npm view "$package" version >/dev/null 2>&1; then
              echo "$package is readable from the registry"
              break
            fi
            if [[ "$attempt" == 15 ]]; then
              echo "$package never became readable from the registry" >&2
              exit 1
            fi
            echo "attempt $attempt: not readable yet, waiting"
            sleep 20
          done

          # The declared entry points must actually be inside the published tarball.
          npm pack --dry-run --json "$package" > packed.json
          node -e '
            const packed = require("./packed.json")[0];
            const files = new Set(packed.files.map((file) => file.path));
            const required = [
              "dist/index.js",
              "dist/index.node.js",
              "dist/worker.js",
              "wasm/deckprobe_wasm.js",
              "wasm/deckprobe_wasm_bg.wasm",
            ];
            const missing = required.filter((path) => !files.has(path));
            if (missing.length) {
              console.error(`registry tarball is missing: ${missing.join(", ")}`);
              process.exit(1);
            }
            console.log(`registry tarball carries all ${required.length} declared entry points (${packed.entryCount} files)`);
          '

          # Install into a clean project, the way a consumer would.
          mkdir -p "$RUNNER_TEMP/consumer"
          cd "$RUNNER_TEMP/consumer"
          npm init -y >/dev/null
          npm install "$package" >/dev/null

          # The Node entry point, its WASM, and the discovery contract.
          cat > check.mjs <<'CHECK'
          import assert from "node:assert/strict";
          import { writeFileSync } from "node:fs";
          import { formats, probeFile, version } from "@deckflow/deckprobe";

          const expected = process.argv[2];
          assert.equal(await version(), expected, "runtime version disagrees with the published version");

          const drivers = (await formats()).formats.map((entry) => entry.driver);
          assert.ok(drivers.includes("pdf"), "discovery did not report the pdf driver");

          // A minimal valid PDF, so the check needs no fixture from the repository.
          writeFileSync("probe.pdf", "%PDF-1.7\n%%EOF\n");
          const report = await probeFile("probe.pdf", { targets: ["@header"] });
          assert.equal(report.schema_version, 2);
          assert.equal(report.input.source_kind, "local_file");
          assert.equal(report.driver.id, "pdf");
          console.log("node entry point, WASM, discovery, and probeFile all work from the registry copy");
          CHECK
          node check.mjs "$version"

          # The CLI resolves through its optional platform package.
          npx --no-install deckprobe --version
          echo "published $package verified from the public registry"

  announce:
    needs:
      - plan
      - host
      - publish-npm
      - verify-published
    # use "always() && ..." to allow us to wait for all publish jobs while
    # still allowing individual publish jobs to skip themselves (for prereleases).
    # "host" however must run to completion, no skipping allowed!
    # verify-published gates the announcement so a release cannot report success
    # while the artifact on the public registry is incomplete.
    if: ${{ always() && needs.host.result == 'success' && needs.publish-npm.result == 'success' && needs.verify-published.result == 'success' }}
    runs-on: "ubuntu-22.04"
    env:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
          submodules: recursive