release.yaml

# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist
# Runner versions pinned; see ci.yaml header comment for rationale.
#
# 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.
#
# SECURITY: This workflow must not load any data cached from other workflow
# runs (e.g. via actions/cache). Cross-job data sharing within this workflow
# (via upload-artifact/download-artifact) is fine since it's scoped to the
# current run.

permissions:
  "contents": "write"

# 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.
name: release

on:
  pull_request:
  push:
    tags:
      - '**[0-9]+.[0-9]+.[0-9]+*'

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  # Run 'dist plan' (or host) to determine what tasks we need to do
  plan:
    runs-on: "ubuntu-24.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.30.2/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:
    # 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 }}
    # Signing and publishing share the admin-controlled tag gate. Pass each
    # credential only to the step that uses it; see .github/AGENTS.md.
    # The tag-only policy rejects this job on PR refs if dist-workspace.toml
    # sets `pr-run-mode = "upload"`.
    environment: release
    env:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json
    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"
      # SignPath is on a self-signed test certificate while the project's OSS
      # application is under review, so signing failures are expected and must
      # not block crates.io/homebrew/winget/AUR publishing.
      - name: Upload unsigned Windows artifact
        if: contains(matrix.targets, 'x86_64-pc-windows-msvc')
        id: upload-unsigned-windows-artifact
        continue-on-error: true
        uses: actions/upload-artifact@v7
        with:
          # The file is already a zip, and upload-artifact wraps its uploads
          # in a storage zip unless told not to — SignPath would then look
          # for the PE files one level too deep. archive: false also makes
          # the artifact take the file's own name (ignoring `name:`), which
          # is what the signing step's output directory has to work around.
          archive: false
          path: target/distrib/worktrunk-x86_64-pc-windows-msvc.zip
      - name: Submit SignPath signing request
        id: signpath
        if: contains(matrix.targets, 'x86_64-pc-windows-msvc') && steps.upload-unsigned-windows-artifact.outcome == 'success'
        continue-on-error: true
        uses: signpath/github-action-submit-signing-request@v3
        with:
          api-token: '${{ secrets.SIGNPATH_API_TOKEN }}'
          organization-id: '56bf7020-7661-4b4e-ad77-b627278eaefd'
          project-slug: 'worktrunk'
          signing-policy-slug: 'test-signing'
          github-artifact-id: '${{ steps.upload-unsigned-windows-artifact.outputs.artifact-id }}'
          wait-for-completion: true
          # A scratch directory, not target/distrib: SignPath names the
          # download after the artifact, so it would land beside the build as
          # …zip.zip and leave the unsigned original in place — how v0.69.1
          # shipped unsigned. The next step takes whatever lands here.
          output-artifact-directory: 'target/signpath'
          # Without this the action unpacks the returned zip into loose files
          # instead of saving it back whole.
          skip-decompress: true
      - name: Replace the Windows artifact with the signed one
        if: contains(matrix.targets, 'x86_64-pc-windows-msvc') && steps.signpath.outcome == 'success'
        continue-on-error: true
        shell: bash
        run: |
          set -euo pipefail
          shopt -s nullglob
          signed=(target/signpath/*)
          if [ ${#signed[@]} -ne 1 ]; then
            echo "::error::expected one signed artifact, found ${#signed[@]}: ${signed[*]-}"
            exit 1
          fi
          # Check the replacement before it overwrites the build: shipping an
          # unsigned zip is tolerable while the certificate is a test one,
          # shipping a corrupt one never is.
          python .github/verify-windows-signature.py "${signed[0]}"
          mv "${signed[0]}" target/distrib/worktrunk-x86_64-pc-windows-msvc.zip
      # Deliberately not continue-on-error, unlike the signing steps: shipping
      # unsigned is tolerable while the certificate is a test one, shipping a
      # checksum that doesn't match the zip is not. That is also why this
      # doesn't fold into the step above.
      - name: Recompute checksum for signed Windows artifact
        if: contains(matrix.targets, 'x86_64-pc-windows-msvc')
        shell: bash
        run: |
          cd target/distrib
          # -b matches cargo-dist's own checksum format (`<hash> *<filename>`);
          # sha256sum's default text mode omits the asterisk.
          sha256sum -b worktrunk-x86_64-pc-windows-msvc.zip > worktrunk-x86_64-pc-windows-msvc.zip.sha256
      # Records what the release actually ships. The step above gates the
      # overwrite; this one answers the question the logs never could — a
      # signing request can complete while the signed file never reaches the
      # release, which is how v0.69.1 shipped unsigned.
      - name: Report whether the shipped Windows artifact is signed
        if: contains(matrix.targets, 'x86_64-pc-windows-msvc')
        continue-on-error: true
        shell: bash
        run: python .github/verify-windows-signature.py target/distrib/worktrunk-x86_64-pc-windows-msvc.zip
      - 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-24.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-24.04"
    # id-token and attestations are for the packslip step below.
    # Gate OIDC on admin-controlled tags, alongside the other release jobs.
    environment: release
    permissions:
      contents: write
      id-token: write
      attestations: write
    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
      # A manifest of the archives (digests, wt/git-wt paths, completions, and
      # skills/ at this commit), signed with this workflow's OIDC identity so
      # installers such as mise can verify a download against this repo.
      # Releases are immutable, so the bundle goes into artifacts/ and ships
      # with `gh release create` below instead of being uploaded after it.
      # See https://packslip.dev.
      - name: Create packslip
        id: packslip
        # Optional channel: a packslip or Sigstore failure must not block the
        # release and every publish job that needs `host`.
        continue-on-error: true
        # continue-on-error only covers a step that exits; bound a stalled
        # Sigstore call so it cannot hold the release until the job timeout.
        timeout-minutes: 10
        uses: jdx/packslip@44e50e5f64551234b4a382d991bd7f7f7d021d06 # v1.11.3
        with:
          artifacts: artifacts/worktrunk-*.tar.xz artifacts/worktrunk-*.zip
          bin: wt git-wt
          resources: |
            completion/bash,zsh,fish,powershell/wt=exec:wt config shell completions {shell}
            completion/bash,zsh,fish,powershell/git-wt=exec:git-wt config shell completions {shell}
            skill/worktrunk=repo:skills/worktrunk
            skill/wt-switch-create=repo:skills/wt-switch-create
          out: packslip
          upload: false
      - name: Stage packslip
        if: steps.packslip.outcome == 'success'
        env:
          BUNDLE: ${{ steps.packslip.outputs.bundle }}
        run: cp "$BUNDLE" artifacts/
      - 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
          # Customize install commands:
          # - Replace tap formula with homebrew-core and add shell install
          # - Add shell install to shell script installer
          # - Add shell install to powershell installer (uses git-wt for Windows)
          echo "$ANNOUNCEMENT_BODY" | sed \
            -e 's/brew install max-sixty\/worktrunk\/wt/brew install worktrunk \&\& wt config shell install/g' \
            -e 's/| sh$/| sh \&\& wt config shell install/g' \
            -e 's/| iex"$/| iex"; git-wt config shell install/g' \
            > $RUNNER_TEMP/notes.txt

          # Append additional install options after the Homebrew section
          printf '\n### Install via Cargo\n\n```sh\ncargo install worktrunk && wt config shell install\n```\n\n### Install via Winget (Windows)\n\n```sh\nwinget install max-sixty.worktrunk && git-wt config shell install\n```\n\n### Install via AUR (Arch Linux)\n\n```sh\nparu worktrunk-bin && wt config shell install\n```\n' >> $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/*

  # Auth is via crates.io Trusted Publishing (GitHub Actions OIDC): the job mints
  # a short-lived, auto-revoked token per run instead of a long-lived API token.
  # This requires a Trusted Publisher to be configured for the crate on
  # crates.io, scoped to this repo, the `release.yaml` workflow, and the
  # `release` environment.
  publish-cargo:
    needs:
      - plan
      - host
    runs-on: ubuntu-24.04
    environment: release
    permissions:
      contents: read
      id-token: write
    if: ${{ needs.plan.outputs.publishing == 'true' }}
    steps:
      - uses: actions/checkout@v7
      - name: Authenticate with crates.io
        id: auth
        uses: rust-lang/crates-io-auth-action@v1
      - name: Publish to crates.io
        env:
          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
        run: cargo publish --package worktrunk

  publish-winget:
    needs:
      - plan
      - host
    runs-on: ubuntu-24.04
    environment: release
    if: ${{ needs.plan.outputs.publishing == 'true' }}
    env:
      GH_TOKEN: ${{ secrets.TEND_BOT_TOKEN }}
    steps:
      - name: Sync winget-pkgs fork with upstream
        run: |
          gh api -X POST repos/max-sixty/winget-pkgs/merge-upstream -f branch=master
      - name: Publish to winget
        uses: vedantmgoyal9/winget-releaser@v2
        with:
          identifier: max-sixty.worktrunk
          version: ${{ needs.plan.outputs.tag }}
          installers-regex: '^worktrunk-.*-windows-.*\.zip$'
          token: ${{ secrets.TEND_BOT_TOKEN }}
          fork-user: max-sixty

  # Homebrew formula is generated by cargo-dist and published here
  publish-homebrew:
    needs:
      - plan
      - host
    runs-on: "ubuntu-24.04"
    environment: release
    env:
      GITHUB_USER: "worktrunk-bot"
      GITHUB_EMAIL: "worktrunk-bot@users.noreply.github.com"
    if: ${{ needs.plan.outputs.publishing == 'true' && (!fromJson(needs.plan.outputs.val).announcement_is_prerelease || fromJson(needs.plan.outputs.val).publish_prereleases) }}
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: true
          repository: "max-sixty/homebrew-worktrunk"
          token: ${{ secrets.TEND_BOT_TOKEN }}
      - name: Fetch homebrew formula
        uses: actions/download-artifact@v8
        with:
          pattern: artifacts-*
          path: Formula/
          merge-multiple: true
      - name: Commit formula
        run: |
          git config --global user.name "${GITHUB_USER}"
          git config --global user.email "${GITHUB_EMAIL}"

          git add Formula/*.rb
          git diff --cached --quiet || git commit -m "wt ${{ needs.plan.outputs.tag }}"
          git push

  publish-aur:
    needs:
      - plan
      - host
    runs-on: ubuntu-24.04
    environment: release
    if: ${{ needs.plan.outputs.publishing == 'true' }}
    steps:
      - uses: actions/checkout@v7
      - name: Update PKGBUILD version
        run: |
          VERSION="${{ needs.plan.outputs.tag }}"
          VERSION="${VERSION#v}"
          sed -i "s/^pkgver=.*/pkgver=${VERSION}/" .github/aur/PKGBUILD
          cat .github/aur/PKGBUILD
      - name: Publish AUR package
        uses: KSXGitHub/github-actions-deploy-aur@v4.2.0
        with:
          pkgname: worktrunk-bin
          pkgbuild: .github/aur/PKGBUILD
          commit_username: worktrunk-bot
          commit_email: worktrunk-bot@users.noreply.github.com
          ssh_private_key: ${{ secrets.AUR_SSH_PRIVATE_KEY }}
          commit_message: Update to ${{ needs.plan.outputs.tag }}
          updpkgsums: true

  announce:
    needs:
      - plan
      - host
      - publish-cargo
      - publish-winget
      - publish-homebrew
      - publish-aur
    # 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!
    if: ${{ always() && needs.host.result == 'success' && (needs.publish-cargo.result == 'success' || needs.publish-cargo.result == 'skipped') && (needs.publish-winget.result == 'success' || needs.publish-winget.result == 'skipped') && (needs.publish-homebrew.result == 'success' || needs.publish-homebrew.result == 'skipped') && (needs.publish-aur.result == 'success' || needs.publish-aur.result == 'skipped') }}
    runs-on: "ubuntu-24.04"
    env:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
          submodules: recursive
      - name: Announce release
        run: echo "Release announced successfully"