ghc.yml

name: GHC (build, test, haddock)

# Controls when the workflow will run
on:
  push:
    branches: [master]
    tags: [v*]
  pull_request:

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

permissions:
  contents: write # to submit Haddock documentation to GitHub Pages

jobs:
  check:
    name: "Run static checks"
    runs-on: ubuntu-latest
    outputs:
      EO: ${{ steps.get-eo-version.outputs.EO }}
    steps:
      - name: 📥 Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: true
          ref: ${{ github.ref }}

      - uses: haskell-actions/run-fourmolu@v10
        with:
          version: "0.14.0.0"
          pattern: |
            eo-phi-normalizer/**/*.hs
            !eo-phi-normalizer/src/Language/EO/Phi/Syntax/**/*.hs
            !eo-phi-normalizer/Setup.hs

      - uses: haskell-actions/hlint-setup@v2

      - name: Get hlint-bin
        id: get-hlint-bin
        run: |
          chmod +x scripts/run-hlint.sh
          echo "hlint-bin=$(realpath scripts/run-hlint.sh)" >> $GITHUB_OUTPUT

      - uses: haskell-actions/hlint-run@v2
        with:
          hlint-bin: ${{ steps.get-hlint-bin.outputs.hlint-bin }}

      - name: Get EO version
        id: get-eo-version
        run: |
          EO="$(yq '.project.parent.version' -p xml < eo/eo-runtime/pom.xml)"

          printf "%s" "$EO"

          printf "EO=$EO\n" >> $GITHUB_OUTPUT

  pipeline:
    name: Run pipeline
    needs: check
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
      fail-fast: false
    permissions:
      contents: write
      pull-requests: write
    steps:
      - name: 📥 Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: true
          ref: ${{ github.ref }}

      - name: 🧰 Setup Stack
        uses: freckle/stack-action@v5
        with:
          stack-build-arguments: --pedantic
          stack-build-arguments-build: --copy-bins
          stack-build-arguments-test: --force-dirty
          # TODO #213:10m enable macos test after https://github.com/objectionary/normalizer/issues/180 is resolved
          # TODO #98:10m enable windows tests after https://github.com/objectionary/normalizer/issues/185 is resolved
          test: ${{ matrix.os != 'windows-latest' && matrix.os != 'macos-latest'}}

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

      - uses: actions/setup-java@v4
        with:
          distribution: "zulu"
          java-version: 21

      - name: Run pipeline
        shell: bash
        env:
          EO: ${{ needs.check.outputs.EO }}
        run: ./scripts/pipeline.sh

      - name: Configure git
        if: always() && runner.os == 'Linux'
        env:
          # required for gh
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          ${{ github.head_ref && format('gh pr checkout {0}', github.event.pull_request.number) || ''}}

          git config --global user.email "github-actions[bot]@users.noreply.github.com"
          git config --global user.name "github-actions[bot]"

      - name: Commit and push changes in normalizer data files
        if: always() && runner.os == 'Linux'
        run: |
          data_directory="eo-phi-normalizer/data"
          if [ -n "$(git status --porcelain $data_directory)" ]; then
            git add $data_directory
            git commit -m "Update normalizer data files"
            git push
          else
            echo "Nothing to commit.";
          fi

      - name: Install mdsh
        if: always() && runner.os == 'Linux'
        uses: baptiste0928/cargo-install@v3.1.0
        with:
          crate: mdsh
          git: https://github.com/zimbatm/mdsh
          branch: main

      - name: Update Markdown files
        if: always() && runner.os == 'Linux'
        run: ./scripts/update-markdown.sh

      - name: Commit and push changes in Markdown files
        if: always() && runner.os == 'Linux'
        run: |
          files="site proposals README.md"

          if [ -n "$(git status --porcelain $files)" ]; then
            git add $files
            git commit -m "Update Markdown files"
            git push
          else
            printf "Nothing to commit."
          fi

      - name: Upload pipeline artifact
        id: pipeline-artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: pipeline-${{ runner.os }}-${{ hashFiles('pipeline/eo/*.eo') }}
          overwrite: true
          path: |
            pipeline
            !pipeline/**/.eoc
            !pipeline/yaml
            pipeline/phi/.eoc/4-pull/org
            pipeline/phi/.eoc/phi/org
            pipeline/phi/.eoc/print/org
            report

      - name: Write about the artifact in the job summary
        if: always()
        shell: bash
        run: |
          cat << EOF >> $GITHUB_STEP_SUMMARY
          <h2>Artifact</h2>
          <p>
            The artifact
            <a href="${{ steps.pipeline-artifact.outputs.artifact-url }}">
              pipeline-${{ runner.os }}-${{ hashFiles('pipeline/eo/*.eo') }}
            </a> contains files used or produced during the pipeline run:
          </p>
          <ul>
            <li>EO and PHI programs</li>
            <li>Reports</li>
          </ul>
          EOF

      - name: Write the report in the job summary
        if: success()
        shell: bash
        run: |
          cat << EOF >> $GITHUB_STEP_SUMMARY
          <h2>Report</h2>
          <details>
            <summary>Click to expand</summary>
            $(cat report/report.md)
          </details>
          EOF

  docs:
    needs: pipeline
    if: ${{ github.ref_name == 'master' }}
    name: "Build and upload site (master)"
    runs-on: ubuntu-latest
    steps:
      - name: 📥 Checkout repository
        uses: actions/checkout@v4
        with:
          ref: ${{ github.ref }}

      - name: 🧰 Setup Stack
        uses: freckle/stack-action@v5
        with:
          test: false
          stack-build-arguments: --fast --haddock
          cache-prefix: docs-

      - name: Download pipeline artifact
        uses: actions/download-artifact@v4
        with:
          pattern: pipeline-${{ runner.os }}-*
          merge-multiple: true

      - name: Setup mdBook
        uses: jontze/action-mdbook@v3
        with:
          token: ${{secrets.GITHUB_TOKEN}}
          mdbook-version: "~0.4.37"
          use-linkcheck: true

      - name: Add haddock
        run: |
          mkdir -p dist/haddock
          mv $(stack path --local-doc-root)/* dist/haddock

      - name: Add docs
        run: |
          cd site/docs
          mdbook build
          mv docs ../../dist

      - name: Add report
        run: |
          mkdir -p dist/report
          cp report/report.html dist/report/index.html

      - name: Add index.html
        run: mv site/index.html dist

      - name: 🚀 Publish Site
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          folder: dist
          single-commit: true