ci.yml

# Main CI Workflow
name: CI

on:
  push:
    branches:
      - 'main'
      - '*.*'
      - '!*backport*'
    tags:
      - 'v*'
      - '!*dev*'
      - '!*pre*'
      - '!*post*'
  pull_request:
  # Allow manual runs through the web UI
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions: {}

jobs:
  core:
    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2  # zizmor: ignore[unpinned-uses]
    with:
      submodules: false
      coverage: codecov
      toxdeps: tox-pypi-filter
      posargs: -n auto --color=yes
      envs: |
        - linux: py313-minimal
    secrets:
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  sdist_verify:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6  # zizmor: ignore[unpinned-uses]
        with:
          persist-credentials: false
      - uses: actions/setup-python@v6  # zizmor: ignore[unpinned-uses]
        with:
          python-version: '3.13'
      - run: python -m pip install -U --user build
      - run: python -m build . --sdist
      - run: python -m pip install -U --user twine
      - run: python -m twine check dist/*

  test:
    needs: [core, sdist_verify]
    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2  # zizmor: ignore[unpinned-uses]
    with:
      submodules: false
      coverage: codecov
      toxdeps: tox-pypi-filter
      posargs: -n auto --color=yes
      libraries: |
        brew:
          - openjpeg
        apt:
          - libopenjp2-7
      envs: |
        - linux: py314
        - windows: py313
        - macos: py313
        - linux: py312-oldestdeps
    secrets:
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  docs:
    needs: [core]
    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2  # zizmor: ignore[unpinned-uses]
    with:
      default_python: '3.13'
      submodules: false
      pytest: false
      toxdeps: tox-pypi-filter
      cache-path: |
        docs/_build/
        docs/generated/
        .tox/sample_data/
      cache-key: docs-${{ github.run_id }}
      libraries: |
        apt:
          - libopenjp2-7
          - graphviz
      envs: |
        - linux: build_docs

  online:
    if: "!startsWith(github.event.ref, 'refs/tags/v')"
    needs: [docs]
    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2  # zizmor: ignore[unpinned-uses]
    with:
      default_python: '3.13'
      submodules: false
      coverage: codecov
      toxdeps: tox-pypi-filter
      libraries: |
        apt:
          - libopenjp2-7
          - graphviz
      envs: |
        - linux: build_docs-gallery
          pytest: false
          cache-path: |
            docs/_build/
            docs/generated/
            .tox/sample_data/
          cache-key: docs-${{ github.run_id }}
        - linux: py313-online
          posargs: -n auto --dist loadgroup --color=yes
    secrets:
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  build_dists:
    # Build wheels on PRs only when labelled. Releases will only be published if tagged ^v.*
    # see https://github-actions-workflows.openastronomy.org/en/latest/publish.html#upload-to-pypi
    if: |
      github.event_name != 'pull_request' ||
      (
        github.event_name == 'pull_request' &&
        contains(github.event.pull_request.labels.*.name, 'Run publish')
      )
    needs: [test, docs]
    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish.yml@v2  # zizmor: ignore[unpinned-uses]
    with:
      sdist: true
      targets: |
        - cp3{12,13,14}-manylinux*_x86_64
        - cp3{12,13,14}-macosx_x86_64
        - cp3{12,13,14}-macosx_arm64
        - cp3{12,13,14}-win_amd64
        - target: cp3{12,13,14}-manylinux_aarch64
          runs-on: ubuntu-24.04-arm
      test_extras: 'tests'
      test_command: 'pytest -p no:warnings --doctest-rst --pyargs sunpy'
      submodules: false
      save_artifacts: true
      upload_to_pypi: false
      upload_to_anaconda: ${{ github.event_name == 'workflow_dispatch' }}
      anaconda_user: scientific-python-nightly-wheels
      anaconda_package: sunpy
      anaconda_keep_n_latest: 1
    secrets:
      anaconda_token: ${{ secrets.anaconda_org_upload_token }}

  publish_pure:
    needs: [publish]
    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2  # zizmor: ignore[unpinned-uses]
    with:
      python-version: "3.13"
      test_extras: 'tests'
      test_command: 'pytest -p no:warnings --doctest-rst -m "not mpl_image_compare" --pyargs sunpy'
      submodules: false
      env: |
        SUNPY_NO_BUILD_ANA_EXTENSION: 1
      save_artifacts: true
      upload_to_pypi: false

  publish:
    if: startsWith(github.ref, 'refs/tags/v')
    name: Upload to PyPI
    runs-on: ubuntu-latest
    needs: [build_dists, publish_pure]
    permissions:
      id-token: write
    environment:
      name: pypi
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v7  # zizmor: ignore[unpinned-uses]
        with:
          merge-multiple: true
          pattern: dist-*
          path: dist

      - run: ls -lha dist/

      - name: Run upload
        uses: pypa/gh-action-pypi-publish@v1  # zizmor: ignore[unpinned-uses]

  notify:
    if: ${{ !cancelled() && github.event_name == 'workflow_dispatch' }}
    needs: [publish_pure, online]
    environment:
      name: matrix
    runs-on: ubuntu-latest
    steps:
      - uses: Cadair/matrix-notify-action@main  # zizmor: ignore[unpinned-uses]
        with:
          matrix_token: ${{ secrets.matrix_access_token }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          homeserver: ${{ secrets.matrix_homeserver }}
          roomid: '!JYqfIVJjWANcHnfktY:cadair.com'
          ignore_pattern: '.*(Load|report overall).*'
          summarise_success: true