cadcraft/.github/workflows/release.yml

# Release pipeline: every push to `release` builds signed installers for every platform and
# creates or updates the draft GitHub Release "CADCraft v<version>". See docs/releasing.md.
#
# Pushes to `release` trigger the run; pushing there is limited by a repository ruleset to org
# admins and the release-managers team. The jobs that sign (macOS, Windows) and the one that
# drafts the GitHub Release run in the `release` environment (restricted to the `release` branch),
# which holds the signing secrets. Every secret is optional: missing ones produce unsigned
# artifacts and a warning, never a failed build. The other jobs (version, Linux, Flatpak, FreeBSD,
# web) sign nothing and get no secrets, so a manual dispatch on any other branch is a dry run of
# them: the environment refuses the signing jobs there, and the draft-release job is skipped.
name: Release

on:
  push:
    branches: [release]
  workflow_dispatch:
    inputs:
      version:
        description: "Version override for a test run, e.g. 0.2.0-rc.1 (empty: Cargo.toml)"
        type: string
        default: ""

permissions:
  contents: read

concurrency:
  group: release-${{ github.ref }}
  # Never cancel a run mid-notarization or mid-upload; a newer push waits its turn.
  cancel-in-progress: false

env:
  CARGO_TERM_COLOR: always
  CARGO_INCREMENTAL: 0
  RUST_BACKTRACE: 1
  CADCRAFT_BUILD_SHA: ${{ github.sha }}
  INPUT_VERSION: ${{ inputs.version }}

jobs:
  version:
    name: version
    runs-on: ubuntu-latest
    outputs:
      version: ${{ steps.v.outputs.version }}
      date: ${{ steps.v.outputs.date }}
      prerelease: ${{ steps.v.outputs.prerelease }}
    steps:
      - uses: actions/checkout@v4
      - id: v
        name: Resolve version
        run: |
          . packaging/env.sh
          v="${INPUT_VERSION#v}"
          v="${v:-$VERSION}"
          if ! printf '%s' "$v" | grep -Eq '^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$'; then
            echo "::error::'$v' is not a version like 1.2.3 or 1.2.3-rc.1"
            exit 1
          fi
          case "$v" in *-*) pre=true ;; *) pre=false ;; esac
          {
            echo "version=$v"
            echo "date=$(date -u +%Y-%m-%d)"
            echo "prerelease=$pre"
          } >>"$GITHUB_OUTPUT"
          echo "### CADCraft v$v (\`${GITHUB_SHA::9}\`)" >>"$GITHUB_STEP_SUMMARY"

  macos:
    name: macOS universal
    needs: version
    runs-on: macos-15-xlarge  # M2 Pro larger runner; use only in release.yml (actions_macos_xl budget caps spend)
    environment: release
    env:
      CADCRAFT_VERSION: ${{ needs.version.outputs.version }}
      CADCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }}
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: aarch64-apple-darwin, x86_64-apple-darwin
      - uses: Swatinem/rust-cache@v2
        with:
          key: release-macos-universal
      - name: Apply version override
        if: inputs.version != ''
        run: cargo xtask version set "$CADCRAFT_VERSION"
      - name: Import signing certificate
        env:
          APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
          APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
          KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }}
        run: packaging/macos/import-cert.sh
      - name: Build, sign, notarize
        env:
          APPLE_ID: ${{ secrets.APPLE_ID }}
          APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
          APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
        run: packaging/macos/package.sh --arch universal
      - uses: actions/upload-artifact@v4
        with:
          name: release-macos
          path: dist/release/*
          if-no-files-found: error
      - name: Remove temporary keychain
        if: always()
        run: |
          if [ -n "${MACOS_KEYCHAIN:-}" ]; then security delete-keychain "$MACOS_KEYCHAIN" || true; fi

  windows:
    name: Windows ${{ matrix.arch }}
    needs: version
    runs-on: windows-latest
    environment: release
    strategy:
      fail-fast: false
      matrix:
        include:
          - { arch: x64, target: x86_64-pc-windows-msvc }
          - { arch: x86, target: i686-pc-windows-msvc }
          # Windows on ARM: cross-compiled on the x64 runner, so signing and WiX run as above.
          - { arch: arm64, target: aarch64-pc-windows-msvc }
    env:
      CADCRAFT_VERSION: ${{ needs.version.outputs.version }}
      CADCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }}
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}
      - uses: Swatinem/rust-cache@v2
        with:
          key: release-windows-${{ matrix.arch }}
      - name: Apply version override
        if: inputs.version != ''
        shell: bash
        run: cargo xtask version set "$CADCRAFT_VERSION"
      - name: Install WiX
        shell: pwsh
        run: |
          dotnet tool install --global wix --version 5.0.2
          wix extension add -g WixToolset.UI.wixext/5.0.2
      - name: Build, sign, package
        shell: pwsh
        env:
          WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }}
          WINDOWS_CERTIFICATE_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }}
          AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
          AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
          AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
          AZURE_SIGNING_ENDPOINT: ${{ secrets.AZURE_SIGNING_ENDPOINT }}
          AZURE_SIGNING_ACCOUNT: ${{ secrets.AZURE_SIGNING_ACCOUNT }}
          AZURE_CERT_PROFILE: ${{ secrets.AZURE_CERT_PROFILE }}
        run: ./packaging/windows/package.ps1 -Arch ${{ matrix.arch }}
      - uses: actions/upload-artifact@v4
        with:
          name: release-windows-${{ matrix.arch }}
          path: dist/release/*
          if-no-files-found: error

  linux:
    name: Linux ${{ matrix.arch }}
    needs: version
    # The oldest GitHub-hosted image, so the binaries only need glibc >= 2.35 (Ubuntu 22.04+,
    # Debian 12+, Fedora 36+, RHEL 10). See docs/releasing.md.
    runs-on: ${{ matrix.runner }}
    # No `environment: release`: this job signs nothing, so it gets no release secrets.
    strategy:
      fail-fast: false
      matrix:
        include:
          - { arch: x86_64, runner: ubuntu-22.04, deb: amd64 }
          - { arch: aarch64, runner: ubuntu-22.04-arm, deb: arm64 }
    env:
      CADCRAFT_VERSION: ${{ needs.version.outputs.version }}
      CADCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }}
      NFPM_VERSION: 2.47.0
    steps:
      - uses: actions/checkout@v4
      - name: Install build and packaging tools
        run: |
          sudo apt-get update
          sudo apt-get install -y --no-install-recommends \
            libxkbcommon-dev libwayland-dev libx11-dev libxrandr-dev libxi-dev libgl1-mesa-dev \
            desktop-file-utils appstream python3-yaml zsync
          curl -fsSL -o "$RUNNER_TEMP/nfpm.deb" \
            "https://github.com/goreleaser/nfpm/releases/download/v${NFPM_VERSION}/nfpm_${NFPM_VERSION}_${{ matrix.deb }}.deb"
          sudo dpkg -i "$RUNNER_TEMP/nfpm.deb"
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
        with:
          key: release-linux-${{ matrix.arch }}
      - name: Apply version override
        if: inputs.version != ''
        run: cargo xtask version set "$CADCRAFT_VERSION"
      - name: Build and package (AppImage, deb, rpm, tar.gz)
        run: packaging/linux/package.sh
      - name: Check the packages
        run: |
          dpkg-deb --info dist/release/*.deb
          dpkg-deb --contents dist/release/*.deb | grep -E 'usr/bin/cadcraft$|metainfo|applications'
          ldd target/release/cadcraft
          python3 -c "import yaml; m = yaml.safe_load(open('packaging/linux/flatpak/ai.storyteller.cadcraft.yml')); assert m['id'] == 'ai.storyteller.cadcraft'"
          for appimage in dist/release/*.AppImage; do
            chmod +x "$appimage"
            APPIMAGE_EXTRACT_AND_RUN=1 "$appimage" --version
            # Update information is embedded, and the .zsync for delta updates sits beside it.
            # Without APPIMAGE_EXTRACT_AND_RUN: with it, the runtime passes --appimage-* options
            # on to the app (which then tries to open a window) instead of answering them.
            "$appimage" --appimage-updateinformation | grep -F 'gh-releases-zsync|'
            test -s "$appimage.zsync"
          done
      - uses: actions/upload-artifact@v4
        with:
          name: release-linux-${{ matrix.arch }}
          path: dist/release/*
          if-no-files-found: error

  linux-riscv64:
    name: Linux riscv64
    needs: version
    # Cross-compiled on x86_64 (no hosted RISC-V runners) against the runner's own Ubuntu release
    # from ports.ubuntu.com, so the binaries need that release's glibc (24.04: 2.39). 22.04's
    # riscv64 ports lag its amd64 updates, which breaks the multiarch install. tar.gz only; the
    # CLI is smoke-tested under QEMU.
    runs-on: ubuntu-24.04
    # No `environment: release`: this job signs nothing, so it gets no release secrets.
    env:
      CADCRAFT_VERSION: ${{ needs.version.outputs.version }}
      CADCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }}
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: riscv64gc-unknown-linux-gnu
      - uses: Swatinem/rust-cache@v2
        with:
          key: release-linux-riscv64
      - name: Apply version override
        if: inputs.version != ''
        run: cargo xtask version set "$CADCRAFT_VERSION"
      - name: Install cross-compilation dependencies
        run: |
          . /etc/os-release
          sudo dpkg --add-architecture riscv64
          # Pin the existing (archive.ubuntu.com) sources to amd64; riscv64 comes from ports.
          if [ -f /etc/apt/sources.list.d/ubuntu.sources ]; then
            sudo sed -i '/^Types: deb/a Architectures: amd64' /etc/apt/sources.list.d/ubuntu.sources
          fi
          if [ -f /etc/apt/sources.list ]; then
            sudo sed -i 's/^deb /deb [arch=amd64] /g' /etc/apt/sources.list
            sudo sed -i 's/^deb-src /deb-src [arch=amd64] /g' /etc/apt/sources.list
          fi
          for suite in "$VERSION_CODENAME" "$VERSION_CODENAME-updates" "$VERSION_CODENAME-security"; do
            echo "deb [arch=riscv64] http://ports.ubuntu.com/ubuntu-ports $suite main universe restricted multiverse"
          done | sudo tee /etc/apt/sources.list.d/riscv64.list
          sudo apt-get update
          sudo apt-get install -y --no-install-recommends \
            gcc-riscv64-linux-gnu binutils-riscv64-linux-gnu libc6-dev-riscv64-cross libc6-dev:riscv64 qemu-user \
            libxkbcommon-dev:riscv64 libwayland-dev:riscv64 libx11-dev:riscv64 libxrandr-dev:riscv64 \
            libxi-dev:riscv64 libgl1-mesa-dev:riscv64
      - name: Build and package (tar.gz)
        env:
          CARGO_TARGET_RISCV64GC_UNKNOWN_LINUX_GNU_LINKER: riscv64-linux-gnu-gcc
          PKG_CONFIG_SYSROOT_DIR: /
          PKG_CONFIG_PATH: /usr/lib/riscv64-linux-gnu/pkgconfig:/usr/share/pkgconfig
          PKG_CONFIG_ALLOW_CROSS: "1"
          CROSS_ARCH: riscv64
          CROSS_TARGET: riscv64gc-unknown-linux-gnu
          CROSS_COMPILE: riscv64-linux-gnu-
          EMULATOR: qemu-riscv64
          QEMU_LD_PREFIX: /usr/riscv64-linux-gnu
        run: packaging/linux/package.sh --formats tar
      - uses: actions/upload-artifact@v4
        with:
          name: release-linux-riscv64
          path: dist/release/*.tar.gz
          if-no-files-found: error

  flatpak:
    name: Flatpak ${{ matrix.arch }}
    needs: [version, linux]
    # Repackages the Linux job's tarball (the same binaries as the AppImage/deb/rpm); no Rust
    # build here. 24.04 for a newer flatpak-builder (1.4) than 22.04 ships.
    runs-on: ${{ matrix.runner }}
    # No `environment: release`: this job signs nothing, so it gets no release secrets.
    strategy:
      fail-fast: false
      matrix:
        include:
          - { arch: x86_64, runner: ubuntu-24.04 }
          - { arch: aarch64, runner: ubuntu-24.04-arm }
    env:
      CADCRAFT_VERSION: ${{ needs.version.outputs.version }}
      CADCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/download-artifact@v4
        with:
          name: release-linux-${{ matrix.arch }}
          path: dist/linux
      - name: Install flatpak-builder
        run: |
          sudo apt-get update
          # librsvg2-common: the SVG pixbuf loader that the host's `appstreamcli compose` (run by
          # flatpak-builder) needs for any scalable icon.
          sudo apt-get install -y --no-install-recommends flatpak flatpak-builder librsvg2-common
          # Ubuntu 24.04's AppArmor blocks the unprivileged user namespaces bubblewrap needs.
          sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
      - name: Build the Flatpak bundle
        run: packaging/linux/flatpak-bundle.sh "dist/linux/cadcraft-$CADCRAFT_VERSION-linux-${{ matrix.arch }}.tar.gz"
      - uses: actions/upload-artifact@v4
        with:
          name: release-flatpak-${{ matrix.arch }}
          path: dist/release/*.flatpak
          if-no-files-found: error

  web:
    name: Web (wasm)
    needs: version
    runs-on: ubuntu-latest
    # No `environment: release`: this job signs nothing, so it gets no release secrets.
    env:
      CADCRAFT_VERSION: ${{ needs.version.outputs.version }}
      CADCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }}
      TRUNK_VERSION: 0.21.14
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: wasm32-unknown-unknown
      - uses: Swatinem/rust-cache@v2
        with:
          key: release-web
      - name: Install trunk
        run: |
          curl -fsSL "https://github.com/trunk-rs/trunk/releases/download/v${TRUNK_VERSION}/trunk-x86_64-unknown-linux-gnu.tar.gz" \
            | tar -xz -C "$HOME/.cargo/bin" trunk
          trunk --version
      - name: Apply version override
        if: inputs.version != ''
        run: cargo xtask version set "$CADCRAFT_VERSION"
      - name: Build and zip
        run: packaging/web/package.sh
      - uses: actions/upload-artifact@v4
        with:
          name: release-web
          path: dist/release/*
          if-no-files-found: error

  freebsd:
    name: FreeBSD x86_64
    needs: version
    # GitHub has no FreeBSD runners: build inside a FreeBSD VM on a Linux runner.
    runs-on: ubuntu-latest
    # No `environment: release`: this job signs nothing, so it gets no release secrets.
    timeout-minutes: 300
    env:
      CADCRAFT_VERSION: ${{ needs.version.outputs.version }}
      CADCRAFT_BUILD_DATE: ${{ needs.version.outputs.date }}
    steps:
      - uses: actions/checkout@v4
      - name: Build and package in a FreeBSD VM
        uses: vmactions/freebsd-vm@c46abacb49f09938ca4e1702d15d836285d694cc # v1
        with:
          release: "14.3"
          usesh: true
          cpu: 4
          mem: 12288
          envs: "CADCRAFT_VERSION CADCRAFT_BUILD_DATE CADCRAFT_BUILD_SHA INPUT_VERSION"
          copyback: true
          prepare: |
            pkg install -y git curl pkgconf cmake python3 libxkbcommon wayland libX11 libXcursor libXrandr libXi libxcb mesa-libs vulkan-loader gtk3 fontconfig freetype2 alsa-lib
            curl -fsSL https://sh.rustup.rs | sh -s -- -y --profile minimal
          run: |
            set -e
            . "$HOME/.cargo/env"
            git config --global --add safe.directory "*"
            if [ -n "$INPUT_VERSION" ]; then cargo xtask version set "$CADCRAFT_VERSION"; fi
            cargo build --release --locked -p cadcraft -p cadcraft-cli
            name="cadcraft-$CADCRAFT_VERSION-freebsd-x86_64"
            mkdir -p "dist/release/$name"
            cp target/release/cadcraft target/release/cadcraft-cli README.md LICENSE-MIT LICENSE-APACHE NOTICE ATTRIBUTION.md "dist/release/$name/"
            mkdir -p "dist/release/$name/icons"
            cp -R assets/app-icon/hicolor "dist/release/$name/icons/" 2>/dev/null || true
            (cd dist/release && tar -czf "$name.tar.gz" "$name" && rm -rf "$name")
            # Keep the copy back to the runner small.
            rm -rf target
      - uses: actions/upload-artifact@v4
        with:
          name: release-freebsd
          path: dist/release/*
          if-no-files-found: error

  release:
    name: Draft GitHub Release
    needs: [version, macos, windows, linux, linux-riscv64, flatpak, web, freebsd]
    # Only the `release` branch publishes; a dry run on another branch stops before this job.
    if: github.ref == 'refs/heads/release'
    runs-on: ubuntu-latest
    environment: release
    permissions:
      contents: write
    env:
      VERSION: ${{ needs.version.outputs.version }}
      PRERELEASE: ${{ needs.version.outputs.prerelease }}
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      GH_REPO: ${{ github.repository }}
    steps:
      - uses: actions/download-artifact@v4
        with:
          pattern: release-*
          path: artifacts
          merge-multiple: true
      - name: Checksums
        working-directory: artifacts
        run: |
          sha256sum -- * | tee SHA256SUMS.txt
      - name: Create or update the draft release
        working-directory: artifacts
        run: |
          tag="v$VERSION"
          title="CADCraft v$VERSION"
          pre=()
          if [ "$PRERELEASE" = true ]; then pre=(--prerelease); fi
          if draft="$(gh release view "$tag" --json isDraft --jq .isDraft 2>/dev/null)"; then
            if [ "$draft" != "true" ]; then
              echo "::error::Release $tag is already published. Bump the version (cargo xtask version set) before pushing to release."
              exit 1
            fi
            echo "Updating draft $tag: replacing its assets"
            gh release view "$tag" --json assets --jq '.assets[].name' | while read -r asset; do
              gh release delete-asset "$tag" "$asset" --yes
            done
            gh release edit "$tag" --draft --title "$title" --target "$GITHUB_SHA" --prerelease="$PRERELEASE"
            gh release upload "$tag" --clobber -- *
          else
            echo "Creating draft $tag"
            gh release create "$tag" --draft --title "$title" --target "$GITHUB_SHA" --generate-notes "${pre[@]}" -- *
          fi
          {
            echo "Draft release **$title** at \`${GITHUB_SHA::9}\`:"
            echo
            sed 's/^/    /' SHA256SUMS.txt
          } >>"$GITHUB_STEP_SUMMARY"