ci.yaml

name: build
on:
  push:

env:
  BINARY_NAME: hchuck
# INFO: The following configuration block ensures that only one build runs per branch,
# which may be desirable for projects with a costly build process.
# Remove this block from the CI workflow to let each CI job run to completion.
concurrency:
  group: build-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: GHC ${{ matrix.ghc-version }} on ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: ['ubuntu-latest', 'windows-latest', 'macos-latest']
        ghc-version: ['9.8']

        include:
          - os: ubuntu-latest
            upx-args: --best --lzma
            strip: true
          - os: windows-latest
            upx-args: -9
            strip: false
          - os: macos-latest
            upx-args: --best
            strip: true

    steps:
      - uses: actions/checkout@v4

      - name: Set up GHC ${{ matrix.ghc-version }}
        uses: haskell-actions/setup@v2
        id: setup
        with:
          ghc-version: ${{ matrix.ghc-version }}
          # Defaults, added for clarity:
          cabal-version: 'latest'
          cabal-update: true

      - name: Configure the build
        run: |
          cabal configure --enable-tests --enable-benchmarks --disable-documentation
          cabal build all --dry-run
        # The last step generates dist-newstyle/cache/plan.json for the cache key.

      - name: Restore cached dependencies
        uses: actions/cache/restore@v3
        id: cache
        env:
          key: ${{ runner.os }}-ghc-${{ steps.setup.outputs.ghc-version }}-cabal-${{ steps.setup.outputs.cabal-version }}
        with:
          path: ${{ steps.setup.outputs.cabal-store }}
          key: ${{ env.key }}-plan-${{ hashFiles('**/plan.json') }}
          restore-keys: ${{ env.key }}-

      - name: Install dependencies
        # If we had an exact cache hit, the dependencies will be up to date.
        if: steps.cache.outputs.cache-hit != 'true'
        run: cabal build all --only-dependencies

      # Cache dependencies already here, so that we do not have to rebuild them should the subsequent steps fail.
      - name: Save cached dependencies
        uses: actions/cache/save@v3
        # If we had an exact cache hit, trying to save the cache would error because of key clash.
        if: steps.cache.outputs.cache-hit != 'true'
        with:
          path: ${{ steps.setup.outputs.cabal-store }}
          key: ${{ steps.cache.outputs.cache-primary-key }}

      - name: Build
        run: cabal build all

      - name: Run tests
        run: cabal test all

      - name: Check cabal file
        run: cabal check

      - name: Build documentation
        run: cabal haddock all

      - name: Install binary
        run: cabal install --installdir artifact/${{ matrix.os }} --install-method copy

      - name: Strip and compress
        uses: svenstaro/upx-action@v2
        with:
          files: artifact/${{ matrix.os }}/${{ env.BINARY_NAME }}*
          args: ${{ matrix.upx-args }}
          strip: ${{ matrix.strip }}

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: ${{ env.BINARY_NAME }}-${{ github.sha }}-${{ matrix.os }}
          path: artifact

  release:
    needs: build
    if: startsWith(github.ref, 'refs/tags/v')
    runs-on: ubuntu-latest
    steps:

      - uses: actions/download-artifact@v4
        with:
          pattern: ${{ env.BINARY_NAME }}-${{ github.sha }}-*
          path: artifact
          merge-multiple: true

      - name: Zip artifacts
        run: |
          find ./artifact -type f -exec chmod a+x {} \;
          zip -j artifact/${{ env.BINARY_NAME }}-${{ github.ref_name }}-ubuntu.zip artifact/ubuntu-latest/${{ env.BINARY_NAME }}
          zip -j artifact/${{ env.BINARY_NAME }}-${{ github.ref_name }}-windows.zip artifact/windows-latest/${{ env.BINARY_NAME }}.exe
          zip -j artifact/${{ env.BINARY_NAME }}-${{ github.ref_name }}-macos.zip artifact/macos-latest/${{ env.BINARY_NAME }}

      - name: Release
        uses: softprops/action-gh-release@v1
        with:
          files: artifact/**/*.zip