update README to fix package name typo #43
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: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| tests: | |
| name: Python ${{ matrix.python-version }} | |
| runs-on: ubuntu-24.04 | |
| strategy: | |
| matrix: | |
| python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] | |
| django-version: ['<4.2', '<5.0', '<5.1'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| allow-prereleases: true | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| cache-dependency-glob: tests/requirements/*.txt | |
| - uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| path: ${{ env.pythonLocation }} | |
| key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-root | |
| - name: Install Dependencies | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: uv pip install -e .[all,dev,test] --system | |
| - name: Install Django | |
| run: pip install "Django${{ matrix.django-version }}" | |
| - name: Install Hatch project manager | |
| run: uv pip install hatch --system | |
| - name: Test | |
| run: hatch run test:test | |
| - name: Coverage | |
| run: hatch run test:cov | |
| - name: Upload coverage data | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-data-${{ matrix.python-version }} | |
| path: '${{ github.workspace }}/.coverage.*' | |
| include-hidden-files: true | |
| if-no-files-found: error | |
| coverage: | |
| name: Coverage | |
| runs-on: ubuntu-24.04 | |
| needs: tests | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| - name: Install dependencies | |
| run: uv pip install --system coverage[toml] --system | |
| - name: Download data | |
| uses: actions/download-artifact@v4 | |
| with: | |
| path: ${{ github.workspace }} | |
| pattern: coverage-data-* | |
| merge-multiple: true | |
| - name: Combine coverage and fail if it's <100% | |
| run: | | |
| python -m coverage combine | |
| python -m coverage html --skip-covered --skip-empty | |
| python -m coverage report --fail-under=100 | |
| echo "## Coverage summary" >> $GITHUB_STEP_SUMMARY | |
| python -m coverage report --format=markdown >> $GITHUB_STEP_SUMMARY | |
| - name: Upload HTML report | |
| if: ${{ failure() }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-report | |
| path: htmlcov |