Updates from the package template (#921) #2239
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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 | |
| 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 | |
| envs: | | |
| - linux: py314 | |
| - windows: py312 | |
| - macos: py312 | |
| - linux: py311-oldestdeps | |
| - linux: asdf_schemas | |
| 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 | |
| posargs: '' | |
| pytest: false | |
| libraries: | |
| apt: | |
| - libopenjp2-7 | |
| - graphviz | |
| cron: | |
| if: | | |
| github.event_name == 'workflow_dispatch' || ( | |
| github.event_name == 'pull_request' && | |
| contains(github.event.pull_request.labels.*.name, 'Run cron CI') | |
| ) | |
| 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 | |
| envs: | | |
| - linux: py314-devdeps | |
| 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_pure_python.yml@v2 # zizmor: ignore[unpinned-uses] | |
| with: | |
| python-version: '3.13' | |
| test_extras: 'all,tests' | |
| test_command: 'pytest -p no:warnings --doctest-rst --pyargs ndcube' | |
| 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, cron] | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: matrix | |
| steps: | |
| - uses: Cadair/matrix-notify-action@main # zizmor: ignore[unpinned-uses] | |
| with: | |
| workflow_description: "CI Workflow" | |
| matrix_token: ${{ secrets.MATRIX_ACCESS_TOKEN }} | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| homeserver: ${{ secrets.MATRIX_HOMESERVER }} | |
| roomid: '!TWSJXVpyflnZOzmSQz:matrix.org' | |
| ignore_pattern: '.*(Load|report overall).*' | |
| summarise_success: true |