Add complete user-facing documentation and remove dev-focused content #1
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
| name: Tests | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.8', '3.9', '3.10', '3.11', '3.12'] | |
| django-version: ['3.2', '4.0', '4.1', '4.2', '5.0'] | |
| exclude: | |
| # Django 5.0 requires Python 3.10+ | |
| - python-version: '3.8' | |
| django-version: '5.0' | |
| - python-version: '3.9' | |
| django-version: '5.0' | |
| # Django 4.2 is LTS, test more thoroughly | |
| - python-version: '3.8' | |
| django-version: '4.0' | |
| - python-version: '3.8' | |
| django-version: '4.1' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v4 | |
| - name: Install dependencies | |
| run: | | |
| uv pip install --system "django==${{ matrix.django-version }}.*" | |
| uv pip install --system -e ".[dev]" | |
| - name: Run tests | |
| run: | | |
| pytest tests/ -v --cov=graphql_sqlcommenter --cov-report=xml --cov-report=term | |
| - name: Upload coverage to Codecov | |
| if: matrix.python-version == '3.11' && matrix.django-version == '4.2' | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| file: ./coverage.xml | |
| fail_ci_if_error: false | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v4 | |
| - name: Install dependencies | |
| run: | | |
| uv pip install --system ruff mypy | |
| - name: Lint with ruff | |
| run: | | |
| ruff check graphql_sqlcommenter/ tests/ | |
| - name: Type check with mypy | |
| run: | | |
| mypy graphql_sqlcommenter/ || true # Allow to fail for now |