develop.yml

name: develop

# Controls when the action will run.
on:
  pull_request:
    branches: [develop, release/*, master]
    types:
      - opened
      - synchronize
      - reopened
      - ready_for_review
  workflow_dispatch:

  #merge queue trigger
  merge_group:
    types:
      - checks_requested

env:
  PFUNIT_VERSION: v4.15.0
  JSON_FORTRAN_VERSION: 8.4.0

# Allow only one concurrent deployment, skipping runs queued between the run
# in-progress and latest queued. We do not wish to waste time on old runs if a
# newer one is available.
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  prepare:
    name: Prepare the environment
    runs-on: ubuntu-latest
    outputs:
      pfunit-version: ${{ steps.store.outputs.pfunit-version }}
      json-fortran-version: ${{ steps.store.outputs.json-fortran-version }}

    steps:
      - name: Check if PR is a draft
        shell: bash
        run: |
          if [ "${{ github.event.pull_request.draft }}" == "true" ]; then
            echo "PR is a draft" >&2
            exit 1
          fi

      - name: Store environment variables
        id: store
        run: |
          echo "flint-global-minimum=$FLINT_GLOBAL_MINIMUM" >> $GITHUB_OUTPUT
          echo "flint-changed-minimum=$FLINT_CHANGED_FILES_MINIMUM" >> $GITHUB_OUTPUT
          echo "pfunit-version=$PFUNIT_VERSION" >> $GITHUB_OUTPUT
          echo "json-fortran-version=$JSON_FORTRAN_VERSION" >> $GITHUB_OUTPUT

  # ========================================================================== #
  # Style and linting checks

  linting:
    name: Linting
    needs: prepare
    uses: ./.github/workflows/check_lint.yml

  formatting:
    name: Formatting
    needs: prepare
    uses: ./.github/workflows/check_format.yml

  depend:
    name: Check .depend file
    needs: prepare
    uses: ./.github/workflows/check_depend.yml
    with:
      json-fortran-version: ${{ needs.prepare.outputs.json-fortran-version }}

  # ========================================================================== #
  # Compilation checks

  GNU:
    name: GNU
    needs:
      - prepare
      - depend
    uses: ./.github/workflows/check_gnu.yml
    with:
      json-fortran-version: ${{ needs.prepare.outputs.json-fortran-version }}
      pfunit-version: ${{ needs.prepare.outputs.pfunit-version }}

  Intel:
    name: Intel
    needs:
      - prepare
      - depend
    uses: ./.github/workflows/check_intel.yml
    with:
      json-fortran-version: ${{ needs.prepare.outputs.json-fortran-version }}

  Nvidia:
    if: ${{ github.event_name != 'pull_request' }}
    name: Nvidia
    needs:
      - prepare
      - depend
    uses: ./.github/workflows/check_nvidia.yml
    with:
      json-fortran-version: ${{ needs.prepare.outputs.json-fortran-version }}

  # ========================================================================== #
  # Regression checks

  Valgrind:
    name: Valgrind
    needs:
      - prepare
      - depend
    uses: ./.github/workflows/check_valgrind.yml
    with:
      json-fortran-version: ${{ needs.prepare.outputs.json-fortran-version }}

      # ========================================================================== #
  # Determine if the PR is ready

  check_complete:
    name: Develop PR Ready
    if: ${{ always() }}
    needs:
      - prepare
      - linting
      - formatting
      - depend
      - GNU
      - Intel
      - Valgrind
      - Nvidia

    runs-on: ubuntu-latest
    env:
      draft_status: ${{ needs.prepare.result }}
      flint_status: ${{ needs.linting.result }}
      format_status: ${{ needs.formatting.result }}
      gnu_status: ${{ needs.GNU.result }}
      intel_status: ${{ needs.Intel.result }}
      valgrind_status: ${{ needs.Valgrind.result }}
      nvidia_status: ${{ needs.Nvidia.result }}

    steps:
      - name: All checks passed
        run: |
          success=true
          fail=()
          if [ "$draft_status" != "success" ]; then
            fail+=("\t- Draft check: $draft_status")
            success=false
          fi

          if [ "$flint_status" != "success" ]; then
            fail+=("\t- Linting check: $flint_status")
            success=false
          fi

          if [ "$format_status" != "success" ]; then
            fail+=("\t- Formatting check: $format_status")
            success=false
          fi

          if [ "$gnu_status" != "success" ]; then
            fail+=("\t- GNU check: $gnu_status")
            success=false
          fi

          if [ "$intel_status" != "success" ]; then
            fail+=("\t- Intel check: $intel_status")
            success=false
          fi

          # Valgrind check is informational only.
          if [ "$valgrind_status" != "success" ]; then
            fail+=("\t- Valgrind check: $valgrind_status (informational only)")
          fi

          # NVidia check is skipped since the compiler is broken.
          # if [ "$nvidia_status" != "success" ]; then
          #   fail+=("\t- NVIDIA check: $nvidia_status")
          #   success=false
          # fi

          if [ ${#fail[@]} -ne 0 ]; then
            >&2 echo "The following checks failed:"
            for i in "${fail[@]}"; do
              >&2 printf "$i\n"
            done
          fi

          if [ "$success" = false ]; then
            exit 1
          fi
          echo "All checks passed"