release.yml

name: Release

on:
  push:
    tags:
      - "*"
  workflow_dispatch:
    inputs:
      tag:
        description: "Release tag (e.g. 0.3.1)"
        required: true
        type: string
      release_name:
        description: "Release title (leave blank to use tag as title)"
        required: false
        type: string
        default: ""

jobs:
  build:
    name: Build (${{ matrix.name }})
    runs-on: ${{ matrix.runner }}
    continue-on-error: ${{ matrix.experimental == true }}

    strategy:
      fail-fast: false
      matrix:
        include:
          - name: windows-x86_64
            runner: windows-latest
            target: x86_64-pc-windows-msvc
            artifact_name: blockwork-windows-x86_64.zip
            installer_arch: x64compatible
            experimental: false

          - name: windows-arm64
            runner: windows-11-arm
            target: aarch64-pc-windows-msvc
            artifact_name: blockwork-windows-arm64.zip
            installer_arch: arm64
            qt_host: windows_arm64
            qt_arch: win64_msvc2022_arm64
            experimental: true

          - name: macos-arm64
            runner: macos-latest
            target: aarch64-apple-darwin
            artifact_name: blockwork-macos-arm64
            qt_host: mac
            qt_arch: clang_64
            experimental: true

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Checkout Blockstitch QML module
        shell: bash
        run: |
          ref="${GITHUB_HEAD_REF:-$GITHUB_REF_NAME}"
          if git ls-remote --exit-code --heads https://github.com/Blockworked/blockstitch.git "$ref" >/dev/null; then
            git clone --depth 1 --branch "$ref" https://github.com/Blockworked/blockstitch.git ../blockstitch
          else
            git clone --depth 1 https://github.com/Blockworked/blockstitch.git ../blockstitch
          fi

      # Official Qt builds where CXX-Qt's Qt download is missing or broken.
      - name: Set up Python
        if: matrix.qt_arch
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'

      - name: Install Qt
        if: matrix.qt_arch
        shell: bash
        run: |
          python -m pip install aqtinstall==3.3.0
          python -m aqt install-qt ${{ matrix.qt_host }} desktop 6.10.3 ${{ matrix.qt_arch }} --outputdir "$RUNNER_TEMP/Qt"
          qmake=$(find "$RUNNER_TEMP/Qt/6.10.3" -maxdepth 3 -path '*/bin/*' \( -name qmake -o -name qmake.exe \) | head -n 1)
          test -n "$qmake"
          if [[ "$RUNNER_OS" == Windows ]]; then qmake=$(cygpath -w "$qmake"); fi
          echo "QMAKE=$qmake" >> "$GITHUB_ENV"

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}

      - name: Cache Rust build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          key: ${{ matrix.target }}

      - name: Build (release, Windows)
        if: runner.os == 'Windows'
        run: cargo build --release --target ${{ matrix.target }} --workspace --exclude blockwork-linux-bridge

      - name: Stage Qt application (Windows)
        if: runner.os == 'Windows'
        shell: pwsh
        run: |
          ./scripts/deploy-qt-windows.ps1 -Target ${{ matrix.target }}
          Compress-Archive -Path "dist/windows-${{ matrix.target }}/*" -DestinationPath "${{ matrix.artifact_name }}" -Force

      - name: Upload artifact
        if: runner.os == 'Windows'
        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.artifact_name }}
          path: ${{ matrix.artifact_name }}
          if-no-files-found: error
          retention-days: 90

      - name: Build macOS app bundle
        if: runner.os == 'macOS'
        env:
          MACOSX_DEPLOYMENT_TARGET: '13.0'
          # Newer Xcode clang lists __yield as a builtin but needs arm_acle.h to declare it (Qt's qyieldcpu.h).
          CXXFLAGS_aarch64_apple_darwin: -include arm_acle.h
        run: ./scripts/build-macos-bundle.sh ${{ matrix.target }}

      - name: Zip macOS app bundle
        if: runner.os == 'macOS'
        run: ditto -c -k --sequesterRsrc --keepParent dist/Blockwork.app ${{ matrix.artifact_name }}.app.zip

      - name: Upload macOS app bundle
        if: runner.os == 'macOS'
        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.artifact_name }}.app.zip
          path: ${{ matrix.artifact_name }}.app.zip
          if-no-files-found: error
          retention-days: 90

      - name: Locate or install Inno Setup
        if: runner.os == 'Windows'
        shell: pwsh
        run: |
          $iscc = "C:\Program Files (x86)\Inno Setup 6\ISCC.exe"
          if (-not (Test-Path $iscc)) {
            choco install innosetup -y
          }

      - name: Determine installer version
        if: runner.os == 'Windows'
        id: installer_version
        shell: pwsh
        run: |
          $tag = "${{ github.event_name == 'workflow_dispatch' && inputs.tag || github.ref_name }}"
          $version = $tag -replace '^v', ''
          echo "value=$version" >> $env:GITHUB_OUTPUT

      - name: Build installer (Inno Setup)
        if: runner.os == 'Windows'
        shell: pwsh
        run: |
          $iscc = "C:\Program Files (x86)\Inno Setup 6\ISCC.exe"
          & $iscc "/DMyAppVersion=${{ steps.installer_version.outputs.value }}" "/DTargetTriple=${{ matrix.target }}" "/DInstallerArch=${{ matrix.installer_arch }}" "/DOutputBaseFilename=blockwork-${{ matrix.name }}-setup" installer\blockwork.iss

      - name: Upload installer artifact
        if: runner.os == 'Windows'
        uses: actions/upload-artifact@v4
        with:
          name: blockwork-${{ matrix.name }}-setup.exe
          path: dist/blockwork-${{ matrix.name }}-setup.exe
          if-no-files-found: error
          retention-days: 90

      - name: Build MSIX (Microsoft Store)
        if: matrix.name == 'windows-x86_64'
        shell: pwsh
        run: ./scripts/build-msix.ps1 -Version "${{ steps.installer_version.outputs.value }}" -Target ${{ matrix.target }} -Arch x64

      - name: Upload MSIX artifact
        if: matrix.name == 'windows-x86_64'
        uses: actions/upload-artifact@v4
        with:
          name: blockwork-windows-x86_64.msix
          path: dist/blockwork-windows-x86_64.msix
          if-no-files-found: error
          retention-days: 90

  linux-appimage:
    name: AppImage (${{ matrix.name }})
    runs-on: ${{ matrix.runner }}

    strategy:
      fail-fast: false
      matrix:
        include:
          - name: linux-x86_64
            runner: ubuntu-latest
            target: x86_64-unknown-linux-gnu
            artifact_name: blockwork-linux-x86_64
            linux_arch: x86_64
            qt_host: linux
            qt_arch: linux_gcc_64

          - name: linux-arm64
            runner: ubuntu-24.04-arm
            target: aarch64-unknown-linux-gnu
            artifact_name: blockwork-linux-arm64
            linux_arch: aarch64
            qt_host: linux_arm64
            qt_arch: linux_gcc_arm64

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Checkout Blockstitch QML module
        shell: bash
        run: |
          ref="${GITHUB_HEAD_REF:-$GITHUB_REF_NAME}"
          if git ls-remote --exit-code --heads https://github.com/Blockworked/blockstitch.git "$ref" >/dev/null; then
            git clone --depth 1 --branch "$ref" https://github.com/Blockworked/blockstitch.git ../blockstitch
          else
            git clone --depth 1 https://github.com/Blockworked/blockstitch.git ../blockstitch
          fi

      # Official Qt builds where CXX-Qt's Qt download is missing or broken.
      - name: Set up Python
        if: matrix.qt_arch
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'

      - name: Install Qt
        if: matrix.qt_arch
        shell: bash
        run: |
          python -m pip install aqtinstall==3.3.0
          python -m aqt install-qt ${{ matrix.qt_host }} desktop 6.10.3 ${{ matrix.qt_arch }} --outputdir "$RUNNER_TEMP/Qt"
          qmake=$(find "$RUNNER_TEMP/Qt/6.10.3" -maxdepth 3 -path '*/bin/*' \( -name qmake -o -name qmake.exe \) | head -n 1)
          test -n "$qmake"
          if [[ "$RUNNER_OS" == Windows ]]; then qmake=$(cygpath -w "$qmake"); fi
          echo "QMAKE=$qmake" >> "$GITHUB_ENV"

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}

      - name: Cache Rust build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          key: ${{ matrix.target }}

      - name: Install Linux system dependencies
        run: |
          sudo apt-get update -qq
          sudo apt-get install -y --no-install-recommends \
            pkg-config \
            build-essential \
            curl \
            wget \
            file \
            libssl-dev \
            libxdo-dev \
            libayatana-appindicator3-dev \
            librsvg2-dev \
            libdbus-1-dev \
            libxkbcommon-dev \
            libxkbcommon-x11-0 \
            libx11-dev \
            libx11-xcb-dev \
            libxtst-dev \
            libwayland-dev \
            wayland-protocols \
            libclang-dev \
            lld \
            libxcb-cursor0 \
            libxcb-icccm4 \
            libxcb-image0 \
            libxcb-keysyms1 \
            libxcb-render-util0 \
            libxcb-shape0 \
            libxcb-util1

      - name: Build (release)
        run: cargo build --release --target ${{ matrix.target }} --workspace --exclude blockwork-linux-bridge

      - name: Build AppImage
        run: |
          export APPIMAGE_EXTRACT_AND_RUN=1
          # linuxdeploy-plugin-qt only bundles xcb unless told otherwise.
          export EXTRA_PLATFORM_PLUGINS=libqwayland.so
          wget -q -O linuxdeploy.AppImage "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-${{ matrix.linux_arch }}.AppImage"
          wget -q -O linuxdeploy-plugin-appimage.AppImage "https://github.com/linuxdeploy/linuxdeploy-plugin-appimage/releases/download/continuous/linuxdeploy-plugin-appimage-${{ matrix.linux_arch }}.AppImage"
          wget -q -O linuxdeploy-plugin-qt.AppImage "https://github.com/linuxdeploy/linuxdeploy-plugin-qt/releases/download/continuous/linuxdeploy-plugin-qt-${{ matrix.linux_arch }}.AppImage"
          chmod +x linuxdeploy.AppImage linuxdeploy-plugin-appimage.AppImage linuxdeploy-plugin-qt.AppImage

          export LD_LIBRARY_PATH="$($QMAKE -query QT_INSTALL_LIBS):${LD_LIBRARY_PATH:-}"
          export QML_SOURCES_PATHS="$PWD/blockwork-qt/qml:$PWD/../blockstitch/qml"

          RELEASE_DIR="target/${{ matrix.target }}/release"

          ./linuxdeploy.AppImage \
            --appdir AppDir \
            --executable "$RELEASE_DIR/blockwork" \
            --executable "$RELEASE_DIR/blockwork-daemon" \
            --desktop-file res/blockwork.desktop \
            --icon-file res/icons/blockwork.png \
            --plugin qt \
            --output appimage
          mv Blockwork*.AppImage ${{ matrix.artifact_name }}.AppImage

      - name: Upload AppImage artifact
        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.artifact_name }}.AppImage
          path: ${{ matrix.artifact_name }}.AppImage
          if-no-files-found: error
          retention-days: 90

  linux-flatpak:
    name: Flatpak (${{ matrix.name }})
    runs-on: ${{ matrix.runner }}

    strategy:
      fail-fast: false
      matrix:
        include:
          - name: linux-x86_64
            runner: ubuntu-latest
            artifact_name: blockwork-linux-x86_64

          - name: linux-arm64
            runner: ubuntu-24.04-arm
            artifact_name: blockwork-linux-arm64

    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Checkout Blockstitch QML module
        shell: bash
        run: |
          ref="${GITHUB_HEAD_REF:-$GITHUB_REF_NAME}"
          if git ls-remote --exit-code --heads https://github.com/Blockworked/blockstitch.git "$ref" >/dev/null; then
            git clone --depth 1 --branch "$ref" https://github.com/Blockworked/blockstitch.git ../blockstitch
          else
            git clone --depth 1 https://github.com/Blockworked/blockstitch.git ../blockstitch
          fi

      - name: Install Flatpak tooling
        run: |
          sudo apt-get update -qq
          sudo apt-get install -y --no-install-recommends flatpak flatpak-builder elfutils
          flatpak remote-add --if-not-exists --user flathub https://flathub.org/repo/flathub.flatpakrepo
          flatpak install --user --noninteractive flathub \
            org.kde.Platform//6.10 org.kde.Sdk//6.10 \
            org.freedesktop.Sdk.Extension.rust-stable//25.08 \
            org.flatpak.Builder

      - name: Generate offline Cargo sources
        run: |
          flatpak run --filesystem="$PWD" --command=flatpak-cargo-generator \
            org.flatpak.Builder -o packaging/flatpak/cargo-sources.json Cargo.lock

      - name: Build Flatpak
        # Offline sandbox build, no host cargo build needed.
        run: |
          manifest=packaging/flatpak/com.blockworked.Blockwork
          awk '
            /# BEGIN app-source/ {
              print
              print "      - type: dir"
              print "        path: ../.."
              print "        skip: [target, .git, .flatpak-builder, flatpak-build, flatpak-repo, packaging/flatpak]"
              skip = "app"
              next
            }
            /# END app-source/ { skip = ""; print; next }
            /# BEGIN blockstitch-source/ {
              print
              print "      - type: dir"
              print "        path: ../../../blockstitch"
              print "        dest: .flatpak-blockstitch"
              print "        skip: [target, .git, node_modules, dist]"
              skip = "blockstitch"
              next
            }
            /# END blockstitch-source/ { skip = ""; print; next }
            !skip
          ' "$manifest.yml" > "$manifest.local.yml"
          flatpak-builder --force-clean --user --default-branch=stable --repo=flatpak-repo flatpak-build "$manifest.local.yml"
          flatpak build-bundle flatpak-repo ${{ matrix.artifact_name }}.flatpak com.blockworked.Blockwork stable

      - name: Upload Flatpak artifact
        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.artifact_name }}.flatpak
          path: ${{ matrix.artifact_name }}.flatpak
          if-no-files-found: error
          retention-days: 90

  release:
    name: Create GitHub Release
    runs-on: ubuntu-latest
    needs: [build, linux-appimage, linux-flatpak]
    if: always()
    permissions:
      contents: write

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Determine release tag
        id: tag
        run: |
          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
            echo "value=${{ inputs.tag }}" >> "$GITHUB_OUTPUT"
          else
            echo "value=${{ github.ref_name }}" >> "$GITHUB_OUTPUT"
          fi

      - name: Determine release name
        id: release_name
        run: |
          NAME="${{ inputs.release_name }}"
          if [ -z "$NAME" ]; then
            NAME="${{ steps.tag.outputs.value }}"
          fi
          echo "value=$NAME" >> "$GITHUB_OUTPUT"

      - name: Build release notes from CHANGELOG.md
        env:
          TAG: ${{ steps.tag.outputs.value }}
        run: |
          VERSION="${TAG#v}"
          awk -v ver="$VERSION" 'index($0, "## [" ver "]") == 1 {flag=1; print; next} flag && /^## \[/ {exit} flag' CHANGELOG.md > /tmp/changelog_section.md
          if [ ! -s /tmp/changelog_section.md ]; then
            echo "## $TAG" > /tmp/changelog_section.md
            echo "" >> /tmp/changelog_section.md
            echo "See commit history since the previous tag for details." >> /tmp/changelog_section.md
          fi
          {
            cat /tmp/changelog_section.md
            echo ""
            echo "## Downloads"
            echo ""
            echo "| Platform | File |"
            echo "|---|---|"
            echo "| Windows x86_64 (installer) | \`blockwork-windows-x86_64-setup.exe\` |"
            echo "| Windows x86_64 (portable Qt bundle) | \`blockwork-windows-x86_64.zip\` |"
            echo "| Windows x86_64 (MSIX, for the Microsoft Store) | \`blockwork-windows-x86_64.msix\` |"
            echo "| Windows arm64 (installer) | \`blockwork-windows-arm64-setup.exe\` |"
            echo "| Windows arm64 (portable Qt bundle) | \`blockwork-windows-arm64.zip\` |"
            echo "| Linux x86_64 (AppImage) | \`blockwork-linux-x86_64.AppImage\` |"
            echo "| Linux x86_64 (Flatpak) | \`blockwork-linux-x86_64.flatpak\` |"
            echo "| Linux arm64 (AppImage) | \`blockwork-linux-arm64.AppImage\` |"
            echo "| Linux arm64 (Flatpak) | \`blockwork-linux-arm64.flatpak\` |"
            echo "| macOS arm64 (app bundle, unsigned) | \`blockwork-macos-arm64.app.zip\` |"
          } > RELEASE_BODY.md
          cat RELEASE_BODY.md

      - name: Download all artifacts
        uses: actions/download-artifact@v4
        with:
          merge-multiple: true
          path: ./release-artifacts

      - name: List release artifacts
        run: ls -lh ./release-artifacts/

      - name: Create GitHub Release
        uses: softprops/action-gh-release@v2
        with:
          tag_name: ${{ steps.tag.outputs.value }}
          name: ${{ steps.release_name.outputs.value }}
          draft: false
          prerelease: false
          fail_on_unmatched_files: false
          files: ./release-artifacts/*
          body_path: RELEASE_BODY.md

  chocolatey:
    name: Chocolatey
    needs: [release]
    uses: ./.github/workflows/chocolatey.yml
    with:
      tag: ${{ github.event_name == 'workflow_dispatch' && inputs.tag || github.ref_name }}
    secrets: inherit

  homebrew:
    name: Homebrew
    needs: [release]
    uses: ./.github/workflows/homebrew.yml
    with:
      tag: ${{ github.event_name == 'workflow_dispatch' && inputs.tag || github.ref_name }}
    secrets: inherit

  winget:
    name: Publish to winget
    runs-on: windows-latest
    needs: [release]
    env:
      WINGET_TOKEN: ${{ secrets.WINGET_TOKEN }}

    steps:
      # Updates an existing package; the first version is submitted by hand
      - name: Open winget-pkgs PR
        if: env.WINGET_TOKEN != ''
        uses: vedantmgoyal9/winget-releaser@main
        with:
          identifier: Blockworked.Blockwork
          release-tag: ${{ github.event_name == 'workflow_dispatch' && inputs.tag || github.ref_name }}
          installers-regex: '-setup\.exe$'
          token: ${{ secrets.WINGET_TOKEN }}