doc: Updated project description #6
Workflow file for this run
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
| # This workflows will upload a Python Package using Twine when a release is created | |
| # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries | |
| name: tests | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - npe2 | |
| tags: | |
| - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10 | |
| pull_request: | |
| branches: | |
| - main | |
| - npe2 | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| test: | |
| name: ${{ matrix.platform }} py${{ matrix.python-version }} | |
| runs-on: ${{ matrix.platform }} | |
| timeout-minutes: 30 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| platform: [ubuntu-latest, windows-latest, macos-latest] | |
| python-version: ["3.10", "3.11", "3.12", "3.13"] | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - name: Setup python | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| activate-environment: "true" | |
| - name: Install Windows OpenGL | |
| uses: pyvista/setup-headless-display-action@v4.2 | |
| with: | |
| qt: true | |
| wm: herbstluftwm | |
| # note: if you need dependencies from conda, considering using | |
| # setup-miniconda: https://github.com/conda-incubator/setup-miniconda | |
| # and | |
| # tox-conda: https://github.com/tox-dev/tox-conda | |
| # this runs the platform-specific tests declared in tox.ini | |
| - name: Test with tox | |
| run: uvx --with tox-gh-actions tox | |
| env: | |
| PLATFORM: ${{ matrix.platform }} | |
| - name: Coverage | |
| uses: codecov/codecov-action@v5 | |
| build-and-inspect-package: | |
| name: Build & inspect package. | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: hynek/build-and-inspect-python-package@v2 | |
| deploy: | |
| # this will run when you have tagged a commit, starting with "v*" | |
| # and requires that you have put your twine API key in your | |
| # github secrets (see readme for details) | |
| needs: [test, build-and-inspect-package] | |
| runs-on: ubuntu-latest | |
| if: contains(github.ref, 'tags') | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download built artifact to dist/ | |
| uses: actions/download-artifact@v5 | |
| with: | |
| name: Packages | |
| path: dist | |
| - name: Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 |