release.yaml

# The way this works is the following:
#
# The create-release job runs purely to initialize the GitHub release itself
# and to output upload_url for the following job.
#
# The build-release job runs only once create-release is finished. It gets the
# release upload URL from create-release job outputs, then builds the release
# executables for each supported platform and attaches them as release assets
# to the previously created release.
#
# The key here is that we create the release only once.
#
# Reference:
# https://eugene-babichenko.github.io/blog/2020/05/09/github-actions-cross-platform-auto-releases/
# https://github.com/BurntSushi/ripgrep/blob/master/.github/workflows/release.yml

name: release
on:
  push:
    # Enable when testing release infrastructure on a branch.
    # branches:
    # - ag/work
    tags:
    - "[0-9]+.[0-9]+.[0-9]+"
jobs:
  create-release:
    name: create-release
    runs-on: ubuntu-22.04
    # env:
    # Set to force version number, e.g., when no tag exists.
    # IRONHIDE_VERSION: TEST-0.0.0
    outputs:
      upload_url: ${{ steps.release.outputs.upload_url }}
      ironhide_version: ${{ env.IRONHIDE_VERSION }}
    steps:
    - name: Get the release version from the tag
      shell: bash
      if: env.IRONHIDE_VERSION == ''
      run: |
        # Apparently, this is the right way to get a tag name. Really?
        #
        # See: https://github.community/t5/GitHub-Actions/How-to-get-just-the-tag-name/m-p/32167/highlight/true#M1027
        echo "IRONHIDE_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
        echo "version is: ${{ env.IRONHIDE_VERSION }}"
    - name: Create GitHub release
      id: release
      uses: ncipollo/release-action@v1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        tag: ${{ env.IRONHIDE_VERSION }}
        name: ${{ env.IRONHIDE_VERSION }}
        allowUpdates: true
        draft: true
        omitDraftDuringUpdate: true

  build-release:
    name: build-release
    needs: ['create-release']
    runs-on: ${{ matrix.os }}
    env:
      CARGO: cargo
      # When CARGO is set to CROSS, this is set to `--target matrix.target`.
      TARGET_FLAGS: ""
      # When CARGO is set to CROSS, TARGET_DIR includes matrix.target.
      TARGET_DIR: ./target
      # Emit backtraces on panics.
      RUST_BACKTRACE: 1
    strategy:
      matrix:
        build: [linux, linux-arm64, linux-arm, macos, macos-arm64, win-msvc, win-gnu]
        include:
        - build: linux
          os: ubuntu-22.04
          target: x86_64-unknown-linux-musl
        - build: linux-arm64
          os: buildjet-4vcpu-ubuntu-2204-arm
          target: aarch64-unknown-linux-gnu
        - build: linux-arm
          os: ubuntu-22.04
          target: arm-unknown-linux-gnueabihf
        - build: macos
          os: macos-12
          target: x86_64-apple-darwin
        - build: macos-arm64
          os: macos-14
          target: aarch64-apple-darwin
        - build: win-msvc
          os: windows-2022
          target: x86_64-pc-windows-msvc
        - build: win-gnu
          os: windows-2022
          target: x86_64-pc-windows-gnu

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

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

    # if we're on windows building with gnu we need to do something special
    - name: Install win-gnu toolchain
      if: matrix.build == 'win-gnu'
      shell: bash
      run: |
        rustup override set $(cat ./rust-toolchain.toml | grep channel | sed 's/channel = "//' | sed 's/"//')-x86_64-gnu

    - name: Use Cross
      shell: bash
      if: matrix.os == 'ubuntu-22.04'
      run: |
        cargo install cross
        echo "CARGO=cross" >> $GITHUB_ENV

    - name: set targets
      shell: bash
      run: |
        echo "TARGET_FLAGS=--target ${{ matrix.target }}" >> $GITHUB_ENV
        echo "TARGET_DIR=./target/${{ matrix.target }}" >> $GITHUB_ENV

    - name: Show command used for Cargo
      run: |
        echo "cargo command is: ${{ env.CARGO }}"
        echo "target flag is: ${{ env.TARGET_FLAGS }}"
        echo "target dir is: ${{ env.TARGET_DIR }}"
    - name: Build release binary
      run: ${{ env.CARGO }} build --verbose --release ${{ env.TARGET_FLAGS }}

    - name: Strip release binary (linux and mac)
      if: matrix.build == 'linux' || matrix.build == 'macos' || matrix.build == 'macos-arm64'
      run: strip "target/${{ matrix.target }}/release/ironhide"

    - name: Strip release binary (arm)
      if: matrix.build == 'linux-arm'
      run: |
        docker run --rm -v \
          "$PWD/target:/target:Z" \
          rustembedded/cross:arm-unknown-linux-gnueabihf \
          arm-linux-gnueabihf-strip \
          /target/arm-unknown-linux-gnueabihf/release/ironhide
    - name: Build archive
      shell: bash
      run: |
        staging="ironhide-${{ needs.create-release.outputs.ironhide_version }}-${{ matrix.target }}"
        mkdir -p "$staging"/{complete,doc}
        cp {README.md,LICENSE} "$staging/"
        if [ "${{ matrix.os }}" = "windows-2022" ]; then
          cp "target/${{ matrix.target }}/release/ironhide.exe" "$staging/"
          7z a "$staging.zip" "$staging"
          echo "ASSET=$staging.zip" >> $GITHUB_ENV
        else
          cp "target/${{ matrix.target }}/release/ironhide" "$staging/"
          tar czf "$staging.tar.gz" "$staging"
          echo "ASSET=$staging.tar.gz" >> $GITHUB_ENV
        fi
    - name: Upload release artifact
      uses: ncipollo/release-action@v1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        tag: ${{ needs.create-release.outputs.ironhide_version }}
        name: ${{ needs.create-release.outputs.ironhide_version }}
        allowUpdates: true
        draft: true
        omitDraftDuringUpdate: true
        artifacts: ${{ env.ASSET }}
        artifactContentType: application/octet-stream

  finalize-release:
    name: finalize-release
    needs: [create-release, build-release]
    runs-on: ubuntu-22.04
    steps:
    - name: Un-draft release
      uses: ncipollo/release-action@v1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        tag: ${{ needs.create-release.outputs.ironhide_version }}
        name: ${{ needs.create-release.outputs.ironhide_version }}
        allowUpdates: true
        draft: false

  crates-release:
    name: crates.io-release
    needs: ['build-release']
    runs-on: ubuntu-22.04
    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
    - name: Install Rust
      uses: dtolnay/rust-toolchain@master
      with:
        toolchain: stable
    - run: cargo publish --token ${CRATES_TOKEN}
      env:
        CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}