update documentation #17
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: Tests | |
| on: | |
| pull_request: {} | |
| push: | |
| branches: [main] | |
| env: | |
| PYTHONWARNDEFAULTENCODING: 'true' | |
| jobs: | |
| tests: | |
| name: ${{ matrix.os }} / ${{ matrix.python-version }} | |
| runs-on: "${{ matrix.os }}-latest" | |
| strategy: | |
| matrix: | |
| os: [Ubuntu, MacOS, Windows] | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| include: | |
| - os: Ubuntu | |
| python-version: pypy-3.8 | |
| fail-fast: false | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Get full Python version | |
| id: full-python-version | |
| run: echo version=$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))") >> $GITHUB_OUTPUT | |
| - name: Bootstrap poetry | |
| run: | | |
| curl -sSL https://install.python-poetry.org | python - -y | |
| - name: Update PATH | |
| if: ${{ matrix.os != 'Windows' }} | |
| run: echo "$HOME/.local/bin" >> $GITHUB_PATH | |
| - name: Update Path for Windows | |
| if: ${{ matrix.os == 'Windows' }} | |
| run: echo "$APPDATA\Python\Scripts" >> $GITHUB_PATH | |
| - name: Set up cache | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }} | |
| - name: Ensure cache is healthy | |
| if: steps.cache.outputs.cache-hit == 'true' | |
| run: | | |
| # `timeout` is not available on macOS, so we define a custom function. | |
| [ "$(command -v timeout)" ] || function timeout() { perl -e 'alarm shift; exec @ARGV' "$@"; } | |
| # Using `timeout` is a safeguard against the Poetry command hanging for some reason. | |
| timeout 10s poetry run pip --version || rm -rf .venv | |
| - name: Check lock file | |
| run: poetry lock --check | |
| - name: Install dependencies | |
| run: poetry install --without examples | |
| - name: Run tests | |
| run: poetry run python -m pytest -p no:sugar -q tests/ | |
| - name: Run mypy | |
| run: poetry run mypy lato | |
| - name: Run doctest | |
| run: poetry run pytest --doctest-modules lato |