release-binary.yml

# CI pipeline for stable binaries
# Keep in sync with:
#   - .github/workflows/debug_build.yml
#   - Dockerfile-CI.Dockerfile
#   - Dockerfile-CI.alpine.Dockerfile
#   - https://github.com/lycheeverse/lychee-action/blob/master/action.yml

name: Release Binary
on:
  release:
    types:
      - published
      - created
      - prereleased
  workflow_dispatch:

env:
  CARGO_TERM_COLOR: always

jobs:
  prepare:
    runs-on: ubuntu-latest
    outputs:
      tag_name: ${{ steps.get_release.outputs.tag_name }}
      upload_url: ${{ steps.get_release.outputs.upload_url }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Get release
        id: get_release
        uses: bruceadams/get-release@v1.3.2
        # Skip step if not in the official repository as it would fail.
        # Instead fail at the end of this workflow.
        if: ${{ github.repository == 'lycheeverse/lychee' }}
        env:
          GITHUB_TOKEN: ${{ github.token }}

  linux:
    permissions:
      contents: write
    runs-on: ubuntu-latest
    needs: prepare
    strategy:
      matrix:
        include:
          - build: x86_64-gnu
            target: x86_64-unknown-linux-gnu
            strip: x86_64-linux-gnu-strip
          - build: x86_64-musl
            target: x86_64-unknown-linux-musl
            strip: x86_64-linux-musl-strip
          - build: arm-gnueabihf
            target: armv7-unknown-linux-gnueabihf
            strip: arm-linux-gnueabihf-strip
            qemu: qemu-arm
          - build: arm-musleabi
            target: arm-unknown-linux-musleabi
            strip: arm-linux-musleabi-strip
            qemu: qemu-arm
          - build: arm-musleabihf
            target: arm-unknown-linux-musleabihf
            strip: arm-linux-musleabihf-strip
            qemu: qemu-arm
          - build: aarch64-gnu
            target: aarch64-unknown-linux-gnu
            strip: aarch64-linux-gnu-strip
            qemu: qemu-aarch64
          - build: aarch64-musl
            target: aarch64-unknown-linux-musl
            strip: aarch64-linux-musl-strip
            qemu: qemu-aarch64
          - build: i686-gnu
            target: i686-unknown-linux-gnu
            strip: x86_64-linux-gnu-strip
            qemu: i386
      fail-fast: false
    steps:
      - name: Install musl tools
        if: ${{ contains(matrix.target, 'musl') }}
        run: sudo apt-get update && sudo apt-get install -y musl-tools

      - name: Install arm tools
        if: ${{ contains(matrix.target, 'arm') }}
        run: |
          echo "GNU_PREFIX=arm-linux-gnueabihf-" >> $GITHUB_ENV
          sudo apt-get update && sudo apt-get install -y binutils-arm-linux-gnueabihf

      - name: Install aarch64 tools
        if: ${{ contains(matrix.target, 'aarch64') }}
        run: |
          echo "GNU_PREFIX=aarch64-linux-gnu-" >> $GITHUB_ENV
          sudo apt-get update && sudo apt-get install -y binutils-aarch64-linux-gnu

      - uses: actions/checkout@v6

      - uses: dtolnay/rust-toolchain@stable

      - name: Build ${{ matrix.target }}
        uses: actions-rs/cargo@v1
        with:
          command: build
          args: --release --target ${{ matrix.target }}
          use-cross: true

      - name: Prepare binary
        run: |
          bin="target/${{ matrix.target }}/release/lychee"
          chmod +x $bin
          echo "BIN=$bin" >> $GITHUB_ENV

      - name: Strip binary (cross)
        run: |
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.strip }}" \
            "/$BIN"

      - name: Prepare release directory
        run: |
          mkdir out out/docs out/complete
          cp $BIN out
          cp README.md docs/*.md out/docs

      - name: Generate man page without emulation
        if: matrix.qemu == ''
        run: |
          $BIN --version
          $BIN --generate man > out/docs/lychee.1

      - name: Generate man page with emulation
        if: matrix.qemu != ''
        run: |
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.qemu }}" "/$BIN" --version
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.qemu }}" "/$BIN" \
              --generate man > "out/docs/lychee.1"

      - name: Generate shell completions without emulation
        if: matrix.qemu == ''
        run: |
          $BIN --generate complete-bash > out/complete/lychee.bash
          $BIN --generate complete-elvish > out/complete/lychee.elv
          $BIN --generate complete-fish > out/complete/lychee.fish
          $BIN --generate complete-powershell > out/complete/_lychee.ps1
          $BIN --generate complete-zsh > out/complete/_lychee

      - name: Generate shell completions with emulation
        if: matrix.qemu != ''
        run: |
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.qemu }}" "/$BIN" \
              --generate complete-bash > "out/complete/lychee.bash"
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.qemu }}" "/$BIN" \
              --generate complete-elvish > "out/complete/lychee.elv"
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.qemu }}" "/$BIN" \
              --generate complete-fish > "out/complete/lychee.fish"
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.qemu }}" "/$BIN" \
              --generate complete-powershell > "out/complete/_lychee.ps1"
          docker run --rm -v \
            "$PWD/target:/target:Z" \
            "ghcr.io/cross-rs/${{ matrix.target }}:main" \
            "${{ matrix.qemu }}" "/$BIN" \
              --generate complete-zsh > "out/complete/_lychee"

      - name: Package release
        run: |
          cd out
          tar -czf lychee.tar.gz lychee docs/ complete/

      - name: Check if possible to release
        if: ${{ needs.prepare.outputs.upload_url == '' }}
        run: |
          echo "Releasing only works on the master/main branch in the official repository."
          exit 1

      - name: Upload .tar.gz
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          asset_name: lychee-${{ matrix.target }}.tar.gz
          asset_path: out/lychee.tar.gz
          upload_url: ${{needs.prepare.outputs.upload_url}}
          asset_content_type: application/gzip

  macos:
    permissions:
      contents: write
    runs-on: macos-latest
    needs: prepare
    steps:
      - uses: actions/checkout@v6

      - uses: dtolnay/rust-toolchain@stable

      - name: Build binary
        uses: actions-rs/cargo@v1
        with:
          command: build
          args: --release
          use-cross: true

      - name: Optimize and package binary
        run: |
          cd target/release
          strip lychee
          chmod +x lychee
          mkdir docs complete
          cp ../../README.md ../../docs/TROUBLESHOOTING.md docs
          ./lychee --generate man > docs/lychee.1
          ./lychee --generate complete-bash > complete/lychee.bash
          ./lychee --generate complete-elvish > complete/lychee.elv
          ./lychee --generate complete-fish > complete/lychee.fish
          ./lychee --generate complete-powershell > complete/_lychee.ps1
          ./lychee --generate complete-zsh > complete/_lychee
          tar -czf lychee.tar.gz lychee docs/ complete/

          mkdir dmg
          mv lychee dmg/
          hdiutil create -fs HFS+ -srcfolder dmg -volname lychee lychee.dmg

      - name: Upload .dmg
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          asset_name: lychee-arm64-macos.dmg
          asset_path: target/release/lychee.dmg
          upload_url: ${{needs.prepare.outputs.upload_url}}
          asset_content_type: application/octet-stream

      - name: Upload .tar.gz
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          asset_name: lychee-arm64-macos.tar.gz
          asset_path: target/release/lychee.tar.gz
          upload_url: ${{needs.prepare.outputs.upload_url}}
          asset_content_type: application/octet-stream

  windows:
    permissions:
      contents: write
    runs-on: windows-latest
    needs: prepare
    steps:
      - uses: actions/checkout@v6

      - uses: dtolnay/rust-toolchain@stable

      - name: Build binary
        uses: actions-rs/cargo@v1
        with:
          command: build
          args: --release
          use-cross: true

      - name: Upload binary
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          asset_name: lychee-x86_64-windows.exe
          asset_path: target/release/lychee.exe
          upload_url: ${{needs.prepare.outputs.upload_url}}
          asset_content_type: application/octet-stream