Repository navigation
Document how to expose 404 responses after CORS preflight #68
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
| name: Main | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| jobs: | |
| quality: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out | |
| uses: actions/checkout@v4 | |
| - uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Set up the environment | |
| uses: ./.github/actions/setup-python-env | |
| - name: Run checks | |
| run: make check | |
| tests-and-type-check: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
| fail-fast: false | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Check out | |
| uses: actions/checkout@v4 | |
| - name: Set up the environment | |
| uses: ./.github/actions/setup-python-env | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Run tests | |
| run: uv run python -m pytest tests --cov --cov-config=pyproject.toml --cov-report=xml | |
| - name: Check typing | |
| run: uv run mypy | |
| - name: Upload coverage reports to Codecov with GitHub Action on Python 3.11 | |
| uses: codecov/codecov-action@v4 | |
| if: ${{ matrix.python-version == '3.11' }} | |
| check-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out | |
| uses: actions/checkout@v4 | |
| - name: Set up the environment | |
| uses: ./.github/actions/setup-python-env | |
| - name: Check if documentation can be built | |
| run: uv run mkdocs build | |
| deploy-docs: | |
| # Publish the docs to GitHub Pages on every push to main, but never from a | |
| # pull request. Gated behind check-docs so a broken build is never deployed. | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| needs: check-docs | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # gh-deploy pushes the built docs to the gh-pages branch | |
| concurrency: | |
| group: deploy-docs | |
| cancel-in-progress: false | |
| steps: | |
| - name: Check out | |
| uses: actions/checkout@v4 | |
| - name: Set up the environment | |
| uses: ./.github/actions/setup-python-env | |
| - name: Deploy documentation | |
| run: uv run mkdocs gh-deploy --force |