add docs check to testing #44
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: Test, lint, and build library | |
| on: [push, pull_request] | |
| jobs: | |
| test-library: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| python-version: [3.11, 3.12, 3.13] | |
| steps: | |
| - name: Checkout | |
| uses: actions/[email protected] | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/[email protected] | |
| with: | |
| python-version: "${{ matrix.python-version }}" | |
| - name: Install Poetry | |
| run: pipx install poetry --python $(which python) | |
| - name: Install project | |
| run: poetry install | |
| - name: Test with tox | |
| run: poetry run tox | |
| test-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/[email protected] | |
| - name: Setup Python | |
| uses: actions/[email protected] | |
| with: | |
| python-version: "3.13" # use latest Python version | |
| - name: Install tox | |
| run: pipx install --python $(which python) tox | |
| - name: Generate docs | |
| run: tox -e docs | |
| - name: Check if repo docs are up to date | |
| run: | | |
| git diff --exit-code HEAD | |
| test-deps: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| python-version: [3.11, 3.12, 3.13] | |
| steps: | |
| - name: Checkout | |
| uses: actions/[email protected] | |
| - name: Setup Python | |
| uses: actions/[email protected] | |
| with: | |
| python-version: "${{ matrix.python-version }}" | |
| - name: Install Poetry | |
| run: pipx install poetry --python $(which python) | |
| - name: Check pyproject.toml | |
| run: poetry check | |
| - name: Check if lockfile is updated | |
| run: poetry lock --check |