add ref to docs #547
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: Tests | |
| on: | |
| - push | |
| - pull_request | |
| jobs: | |
| test: | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: ${{ matrix.experimental }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - name: Test suite with py310-ubuntu | |
| python: "3.10" | |
| os: ubuntu-latest | |
| toxenv: py310 | |
| experimental: false | |
| - name: Test suite with py311-ubuntu | |
| python: "3.11" | |
| os: ubuntu-latest | |
| toxenv: py311 | |
| experimental: false | |
| - name: Test suite with py312-ubuntu | |
| python: "3.12" | |
| os: ubuntu-latest | |
| toxenv: py312 | |
| experimental: false | |
| - name: Test suite with py313-ubuntu | |
| python: "3.13" | |
| os: ubuntu-latest | |
| toxenv: py313 | |
| experimental: false | |
| - name: Type check with mypy | |
| python: "3.10" | |
| os: ubuntu-latest | |
| toxenv: type | |
| experimental: false | |
| - name: Formatting and linting with ruff | |
| python: "3.10" | |
| os: ubuntu-latest | |
| toxenv: ruff | |
| experimental: false | |
| - name: Codacy Coverage Report | |
| python: "3.10" | |
| os: ubuntu-latest | |
| toxenv: coverage | |
| experimental: false | |
| name: ${{ matrix.name }} | |
| env: | |
| # Color Output | |
| # Rich (pip) | |
| FORCE_COLOR: 1 | |
| # Tox | |
| PY_COLORS: 1 | |
| # MyPy | |
| TERM: xterm-color | |
| MYPY_FORCE_COLOR: 1 | |
| MYPY_FORCE_TERMINAL_WIDTH: 200 | |
| # Pytest | |
| PYTEST_ADDOPTS: "--color=yes" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| check-latest: true | |
| - name: Set up tox environment | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install tox | |
| tox -e ${{ matrix.toxenv }} --notest | |
| - name: Test | |
| run: tox -e ${{ matrix.toxenv }} --skip-pkg-install | |
| - name: Run codacy-coverage-reporter | |
| if: ${{ matrix.toxenv == 'coverage' && github.repository == 'martinvonk/spei' && success() }} | |
| uses: codacy/codacy-coverage-reporter-action@master | |
| with: | |
| project-token: ${{ secrets.CODACY_PROJECT_TOKEN }} | |
| coverage-reports: coverage.xml |