docs: Add comments to typing example #229
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: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| main: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - name: "Test: Python 3.8" | |
| python: "3.8" | |
| tox: py38 | |
| - name: "Test: Python 3.9" | |
| python: "3.9" | |
| tox: py39 | |
| - name: "Test: Python 3.10" | |
| python: "3.10" | |
| tox: py310 | |
| - name: "Test: Python 3.11" | |
| python: "3.11" | |
| tox: py311 | |
| coverage: true | |
| - name: "Lint: black" | |
| python: "3.11" | |
| tox: black | |
| - name: "Lint: mypy" | |
| python: "3.11" | |
| tox: mypy | |
| - name: "Lint: pyright" | |
| python: "3.11" | |
| tox: pyright | |
| - name: "Lint: ruff" | |
| python: "3.11" | |
| tox: ruff | |
| - name: "Docs" | |
| python: "3.11" | |
| tox: docs | |
| name: ${{ matrix.name }} | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Cache pip | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-${{ matrix.python }}-${{ matrix.tox }}-pip-${{ hashFiles('pyproject.toml', 'tox.ini') }} }} | |
| restore-keys: | | |
| ${{ runner.os }}-${{ matrix.python }}-${{ matrix.tox }}-pip- | |
| - run: python -m pip install poetry==1.5.1 tox==4.5.2 | |
| - run: python -m tox -e ${{ matrix.tox }} | |
| if: ${{ ! matrix.coverage }} | |
| - run: python -m tox -e ${{ matrix.tox }} -- --cov-report=xml | |
| if: ${{ matrix.coverage }} | |
| - uses: codecov/codecov-action@v3 | |
| if: ${{ matrix.coverage }} | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} |