ci_tests_dev.yaml

# Test PyGMT with GMT dev version on Linux/macOS/Windows
#
# This workflow runs regular PyGMT tests with the GMT dev version, and also pre-release
# versions of several dependencies like NumPy, pandas, Xarray, etc. If any tests fail,
# it also uploads the diff images as workflow artifacts. The GMT dev version is
# installed by fetching the latest source codes from the GMT master branch and
# compiling.
#
# It is triggered in a pull request if labeled with 'run/test-gmt-dev'.
# It is also scheduled to run on Monday, Wednesday, and Friday on the main branch.
#
name: GMT Dev Tests

on:
  # push:
  #   branches: [ main ]
  pull_request:
    types: [ opened, reopened, labeled, synchronize ]
    paths:
      - 'pygmt/**'
      - '.github/actions/checkout-lfs/action.yml'
      - '.github/workflows/ci_tests_dev.yaml'
  workflow_dispatch:
  # Schedule tests on Monday/Wednesday/Friday
  schedule:
    - cron: '0 0 * * 1,3,5'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

permissions: {}

jobs:
  test_gmt_dev:
    name: ${{ matrix.os }} - GMT ${{ matrix.gmt_git_ref }}
    runs-on: ${{ matrix.os }}
    environment:
      name: pr-tests
      deployment: false
    if: github.event_name != 'pull_request' || contains(github.event.pull_request.labels.*.name, 'run/test-gmt-dev')
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-26.04, ubuntu-26.04-arm, macos-26, windows-2025]
        gmt_git_ref: [master]
    timeout-minutes: 30
    defaults:
      run:
        shell: bash -l {0}

    steps:
      # Checkout current git repository
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
          lfs: false

      - name: Get current week number of year
        id: date
        run: echo "date=$(date +%Y-W%W)" >> $GITHUB_OUTPUT  # e.g., 2024-W19

      # Install Micromamba with conda-forge dependencies
      - name: Setup Micromamba
        uses: mamba-org/setup-micromamba@f457c30a868e4760d3a6fcea5f25dc655b8edf39 # v3.2.1
        with:
          environment-name: pygmt
          cache-environment: true
          # environment cache is persistent for one week.
          cache-environment-key: micromamba-environment-${{ steps.date.outputs.date }}
          create-args: >-
            python=3.15
            cmake
            make
            ninja
            curl
            fftw
            ghostscript=10.08.0
            glib
            hdf5
            libblas
            libcblas
            libgdal
            liblapack
            libnetcdf
            pcre
            zlib

      # Install the GSHHG and DCW datasets on Linux/macOS to avoid corrupted files
      # during GMT auto-downloading. Currently, we can't install them on Windows CI,
      # because the Windows CI fails to compile "gshhg_version.c" due to unknown reasons
      # (likely missing DLLs).
      - name: Install GMT GSHHG and DCW datasets (Linux/macOS)
        run: micromamba install dcw-gmt gshhg-gmt
        if: runner.os != 'Windows'

      # Checkout current GMT repository
      - name: Checkout the GMT source from ${{ matrix.gmt_git_ref }} branch
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          repository: 'GenericMappingTools/gmt'
          ref: ${{ matrix.gmt_git_ref }}
          path: 'gmt'
          persist-credentials: false

      - name: Set up MSVC environment (Windows)
        if: runner.os == 'Windows'
        uses: TheMrMilchmann/setup-msvc-dev@368ef7d1ee4d1171b31d4a7f67f4d954f903f5a9 # v4.1.0
        with:
          arch: x64

      # Build GMT from source.
      # Script is adapted from https://github.com/GenericMappingTools/gmt/blob/6.5.0/ci/build-gmt.sh
      - name: Build GMT from source
        shell: bash
        run: |
          cd gmt/
          mkdir build
          cd build
          if [[ "$RUNNER_OS" == "Windows" ]]; then
            CMAKE_PREFIX_PATH="$MAMBA_ROOT_PREFIX/envs/pygmt/Library"
          else
            CMAKE_PREFIX_PATH="$MAMBA_ROOT_PREFIX/envs/pygmt"
          fi
          cmake -G Ninja .. \
            -DCMAKE_PREFIX_PATH="$CMAKE_PREFIX_PATH" \
            -DCMAKE_INSTALL_PREFIX="$GMT_INSTALL_DIR" \
            -DCMAKE_BUILD_TYPE=Release \
            -DGMT_ENABLE_OPENMP=TRUE \
            -DGMT_USE_THREADS=TRUE
          cmake --build .
          cmake --build . --target install
          cd ..
          rm -rf build
        env:
          GMT_INSTALL_DIR: ${{ runner.temp }}/gmt-install-dir

      - name: Add GMT's bin to PATH
        run: echo '${{ runner.temp }}/gmt-install-dir/bin' >> $GITHUB_PATH

      # Install dependencies from PyPI
      - name: Install dependencies
        run: |
          python -m pip install --pre --prefer-binary \
                        --extra-index https://pypi.anaconda.org/scientific-python-nightly-wheels/simple \
                        numpy pandas xarray packaging \
                        build contextily geopandas ipython pyarrow rioxarray \
                        --group test

      # Show installed pkg information for postmortem diagnostic
      - name: List installed packages
        run: micromamba list

      - name: Checkout the Git LFS (i.e., the baseline images) objects
        uses: $/.github/actions/checkout-lfs

      # Download cached remote files (artifacts) from GitHub
      - name: Download remote data from GitHub
        uses: $/.github/actions/download-gmt-cache

      # Install the package that we want to test
      - name: Install the package
        run: make install

      # Run the tests
      - name: Test with pytest
        run: make test PYTEST_EXTRA="-r P --reruns 2"
        env:
          GMT_DATA_SERVER: https://opentopography.s3.sdsc.edu/gmtdata
          GMT_LIBRARY_PATH: ${{ runner.temp }}/gmt-install-dir/lib

      # Upload diff images on test failure
      - name: Upload diff images if any test fails
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        if: ${{ failure() }}
        with:
          name: artifact-${{ matrix.os }}-GMT-${{ matrix.gmt_git_ref }}
          path: tmp-test-dir-with-unique-name