tests #114
This file contains 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
| name: tests | |
| on: | |
| push: | |
| # Avoid using all the resources/limits available by checking only | |
| # relevant branches and tags. Other branches can be checked via PRs. | |
| # branches: [main] | |
| tags: ['v[0-9]*', '[0-9]+.[0-9]+*'] # Match tags that resemble a version | |
| pull_request: | |
| paths: ['.github/workflows/ci.yml'] # On PRs only when this file itself is changed | |
| workflow_dispatch: # Allow manually triggering the workflow | |
| schedule: | |
| # Run roughly every 15 days at 00:00 UTC | |
| # (useful to check if updates on dependencies break the package) | |
| - cron: '0 0 1,16 * *' | |
| concurrency: | |
| group: >- | |
| ${{ github.workflow }}-${{ github.ref_type }}- | |
| ${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| env: | |
| VALIDATE_PYPROJECT_CACHE_REMOTE: tests/.cache | |
| jobs: | |
| prepare: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| wheel-distribution: ${{ steps.wheel-distribution.outputs.path }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: {fetch-depth: 0} # deep clone for setuptools-scm | |
| - uses: actions/setup-python@v5 | |
| with: {python-version: "3.10"} | |
| - name: Run static analysis and format checkers | |
| run: pipx run --python python3.10 tox -e lint,typecheck | |
| - name: Build package distribution files | |
| run: pipx run --python python3.10 tox -e clean,build | |
| - name: Record the path of wheel distribution | |
| id: wheel-distribution | |
| run: echo "path=$(ls dist/*.whl)" >> $GITHUB_OUTPUT | |
| - name: Store the distribution files for use in other stages | |
| # `tests` and `publish` will use the same pre-built distributions, | |
| # so we make sure to release the exact same package that was tested | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: python-distribution-files | |
| path: dist/ | |
| retention-days: 1 | |
| - name: Download files used for testing | |
| run: python3.10 tools/cache_urls_for_tests.py | |
| - name: Store downloaded files | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: test-download-files | |
| path: ${{ env.VALIDATE_PYPROJECT_CACHE_REMOTE }} | |
| include-hidden-files: true | |
| if-no-files-found: error | |
| retention-days: 1 | |
| test: | |
| needs: prepare | |
| strategy: | |
| matrix: | |
| python: | |
| - "3.8" # oldest Python supported by PSF | |
| - "3.12" # newest Python that is stable | |
| platform: | |
| - ubuntu-latest | |
| - macos-13 | |
| - windows-latest | |
| runs-on: ${{ matrix.platform }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Retrieve pre-built distribution files | |
| uses: actions/download-artifact@v4 | |
| with: {name: python-distribution-files, path: dist/} | |
| - name: Retrieve test download files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: test-download-files | |
| path: ${{ env.VALIDATE_PYPROJECT_CACHE_REMOTE }} | |
| - name: Run tests | |
| run: >- | |
| pipx run tox | |
| --installpkg '${{ needs.prepare.outputs.wheel-distribution }}' | |
| -- -n 5 -rFEx --durations 10 --color yes | |
| - name: Generate coverage report | |
| run: pipx run coverage lcov -o coverage.lcov | |
| - name: Upload partial coverage report | |
| uses: coverallsapp/github-action@master | |
| with: | |
| path-to-lcov: coverage.lcov | |
| github-token: ${{ secrets.github_token }} | |
| flag-name: ${{ matrix.platform }} - py${{ matrix.python }} | |
| parallel: true | |
| finalize: | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Finalize coverage report | |
| uses: coverallsapp/github-action@master | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| parallel-finished: true | |
| publish: | |
| needs: finalize | |
| if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags/') }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: {python-version: "3.10"} | |
| - name: Retrieve pre-built distribution files | |
| uses: actions/download-artifact@v4 | |
| with: {name: python-distribution-files, path: dist/} | |
| - name: Publish Package | |
| env: | |
| # See: https://pypi.org/help/#apitoken | |
| TWINE_REPOSITORY: pypi | |
| TWINE_USERNAME: __token__ | |
| TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} | |
| run: pipx run tox -e publish |