docs: Improve README #39
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: PR | |
| on: | |
| pull_request: | |
| types: | |
| - edited | |
| - opened | |
| - synchronize | |
| jobs: | |
| lint-pr-title: | |
| name: Lint PR title | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Validate conventional commit format | |
| uses: amannn/action-semantic-pull-request@v6 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| # Mirrors changelog-sections in release-please-config.json | |
| types: | | |
| feat | |
| fix | |
| infra | |
| ci | |
| docs | |
| deps | |
| perf | |
| refactor | |
| test | |
| chore | |
| qa: | |
| name: Check software quality | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read # Required for actions/checkout | |
| id-token: write # For OIDC authentication, e.g. Codecov | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - name: Set up Python | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: "3.14" | |
| enable-cache: true | |
| - name: Validate generated types are up to date | |
| run: | | |
| make generate-code-references-types | |
| git diff --exit-code | |
| - name: Run linters | |
| run: make lint | |
| - name: Run tests | |
| env: | |
| PYTEST_ADDOPTS: --cov --cov-report xml | |
| run: make test | |
| - name: Upload coverage | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| use_oidc: true |