sunkit-magex/.github/workflows/ci.yml at main · sunpy/sunkit-magex · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# 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:
  schedule:
    #        ┌───────── minute (0 - 59)
    #        │ ┌───────── hour (0 - 23)
    #        │ │ ┌───────── day of the month (1 - 31)
    #        │ │ │ ┌───────── month (1 - 12 or JAN-DEC)
    #        │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT)
    - cron: '0 7 * * 3'  # Every Wed at 07:00 UTC

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
      envs: |
        - linux: py313
    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
      envs: |
        - name: py314 (Expected to Fail)
          linux: py314
        - windows: py312
        - macos: py312
        - linux: py312-oldestdeps
        - linux: py314-devdeps
    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
      libraries: |
        apt:
          - graphviz
      envs: |
        - linux: build_docs

  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_pure_python.yml@v2  # zizmor: ignore[unpinned-uses]
    with:
      python-version: '3.13'
      test_extras: 'tests'
      test_command: 'pytest -p no:warnings --doctest-rst --pyargs sunkit_magex'
      submodules: false
      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]
    permissions:
      id-token: write
    environment:
      name: pypi
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v8  # 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.13.0  # zizmor: ignore[unpinned-uses]

  notify:
    if: ${{ !cancelled() && (github.event_name == 'workflow_dispatch' || github.event_name == 'schedule') }}
    needs: [build_dists]
    runs-on: ubuntu-latest
    environment:
      name: matrix
    steps:
      - uses: Cadair/matrix-notify-action@main  # zizmor: ignore[unpinned-uses]
        with:
          workflow_description: 'CI Workflow in sunpy/sunkit-magex'
          matrix_token: ${{ secrets.MATRIX_ACCESS_TOKEN }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          homeserver: ${{ secrets.MATRIX_HOMESERVER }}
          roomid: '!jfEXWJFdXwYnBWsiqk:openastronomy.org'
          ignore_pattern: '.*(Load|report overall).*'
          summarise_success: true