pull-request-checks.yml

name: Pull request checks

on:
  pull_request:
  push:
    branches:
      - "main"
  workflow_dispatch:

# Cancel running pull request checks if another commit is pushed.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  tests:
    runs-on: ubuntu-latest
    timeout-minutes: 20
    strategy:
      fail-fast: false
      matrix:
        py-ver: ["py311", "py312", "py313"]
    steps:
      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683

      - name: Cache conda environment
        id: conda-env-cache
        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684
        with:
          key: conda|${{runner.os}}-${{runner.arch}}|${{ hashFiles(format('requirements/locks/{0}-lock-linux-64.txt', matrix.py-ver)) }}
          path: |
            ~/conda-env
            ~/.local/share/cartopy
      - name: Create conda environment
        if: steps.conda-env-cache.outputs.cache-hit != 'true'
        run: |
          # Check cache hasn't pulled a partial key match.
          test ! -e "${HOME}/conda-env"
          conda create --prefix="${HOME}/conda-env" --file=requirements/locks/${{ matrix.py-ver }}-lock-linux-64.txt
      - name: Add conda environment to PATH
        run: echo "${HOME}/conda-env/bin" >> $GITHUB_PATH
      - name: Run tests
        env:
          PY_COLORS: "1"
        run: |
          # Install package and run pytest.
          echo '::group::Installing local package'
          pip install --no-deps .
          echo '::endgroup::'
          echo '::group::Running unit tests'
          pytest -n logical --verbose --cov --cov-append --cov-config=pyproject.toml
          echo '::endgroup::'
          mv .coverage ".coverage.${{ matrix.py-ver }}"
      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
        with:
          name: coverage-data-${{ matrix.py-ver }}
          path: .coverage.*
          retention-days: 1
          include-hidden-files: true

  coverage-report:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    timeout-minutes: 20
    needs: tests
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - name: Setup python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065
        with:
          python-version: "3.x"
      - name: Install coverage
        run: pip install coverage
      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
        with:
          pattern: coverage-data-*
          merge-multiple: true
      - name: Generate coverage report
        run: |
          coverage combine
          coverage html
      - name: Add report to PR
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          # This links to a hosted version of the HTML report.
          tar -czf coverage-report.tar.gz htmlcov/
          report_url="$(curl -sSf --data-binary @coverage-report.tar.gz https://tmpweb.net)"
          badge_options="$(coverage json --fail-under=0 -qo - | jq -r .totals.percent_covered_display)%25-blue?style=for-the-badge"
          echo "[![Coverage](https://img.shields.io/badge/coverage-${badge_options})](${report_url})" >> ${{ runner.temp }}/cov-report.md
          # Edit last comment if it exists, else create new one.
          if ! gh pr comment --repo "${{ github.repository }}" --edit-last --create-if-none "${{ github.head_ref }}" --body-file "${{ runner.temp }}/cov-report.md" ; then
            echo "Failed to post comment. This is likely due to this being a PR from a fork."
          fi
      - name: Check 95% minimum coverage
        run: coverage report --fail-under=95

  pre-commit:
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - name: Set up Python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065
        with:
          python-version: "3.x"
      - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684
        with:
          key: pre-commit|${{runner.os}}-${{runner.arch}}|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
          path: ~/.cache/pre-commit
      - name: Set up pre-commit
        run: pip install pre-commit
      - name: Run pre-commit
        env:
          RUFF_OUTPUT_FORMAT: github
        run: pre-commit run --show-diff-on-failure --color=always --all-files

  build-docs:
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - name: Cache conda environment
        id: conda-env-cache
        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684
        with:
          key: conda|${{runner.os}}-${{runner.arch}}|${{hashFiles('requirements/locks/py313-lock-linux-64.txt')}}
          path: |
            ~/conda-env
            ~/.local/share/cartopy
      - name: Create conda environment
        if: steps.conda-env-cache.outputs.cache-hit != 'true'
        run: |
          # Check cache hasn't pulled a partial key match.
          test ! -e "${HOME}/conda-env"
          conda create --prefix="${HOME}/conda-env" --file=requirements/locks/py313-lock-linux-64.txt
      - name: Add conda environment to PATH
        run: echo "${HOME}/conda-env/bin" >> $GITHUB_PATH
      - name: Build documentation with Sphinx
        run: |
          # Install module so it can be imported during docs generation.
          echo '::group::Installing local package'
          pip install --no-deps .
          echo '::endgroup::'
          # Generate the documentation
          echo '::group::Building the documentation'
          sphinx-build -b html --color --fail-on-warning "docs/source" "docs/build/html"
          echo '::endgroup::'
      - name: Upload documentation artifact
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
        with:
          name: html-docs
          path: docs/build/html/
          retention-days: 7
          if-no-files-found: error

  pages-deploy:
    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    timeout-minutes: 20
    needs: build-docs
    steps:
      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
        with:
          name: html-docs

      - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
        with:
          path: "."

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e