chore: updated README #11
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: Code Quality | |
| on: | |
| workflow_call: | |
| # The "on push" event is necessary for the README badges | |
| push: | |
| branches: ['main'] | |
| pull_request: | |
| branches: ['main'] | |
| jobs: | |
| setup: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" # Cached by github (https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md#python) | |
| cache: "pip" | |
| cache-dependency-path: | | |
| ./uv.lock | |
| - name: Cache venv | |
| id: cache-venv | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: python-3-12-venv-${{ hashFiles('./uv.lock') }} | |
| - name: Install dependencies | |
| if: ${{ steps.cache-venv.outputs.cache-hit != 'true' }} | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install uv | |
| uv sync --frozen | |
| ruff: | |
| needs: setup | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: "pip" | |
| cache-dependency-path: | | |
| ./uv.lock | |
| - name: Cache venv | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: python-3-12-venv-${{ hashFiles('./uv.lock') }} | |
| - name: Run ruff | |
| run: | | |
| . .venv/bin/activate | |
| ruff check --select I . | |
| ruff check . | |
| ruff format --check . | |
| mypy: | |
| needs: setup | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: "pip" | |
| cache-dependency-path: | | |
| ./uv.lock | |
| - name: Cache venv | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: python-3-12-venv-${{ hashFiles('./uv.lock') }} | |
| - name: Run mypy | |
| run: | | |
| . .venv/bin/activate | |
| mypy . | |
| coverage: | |
| needs: setup | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: "pip" | |
| cache-dependency-path: | | |
| ./uv.lock | |
| - name: Cache venv | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: python-3-12-venv-${{ hashFiles('./uv.lock') }} | |
| - name: Run mypy | |
| run: | | |
| . .venv/bin/activate | |
| coverage run django_utils_kit/tests/setup.py | |
| coverage report --fail-under=90 |