docs: Update CONTRIBUTING.md #1482
Workflow file for this run
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: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| test: | |
| name: test ${{ matrix.tox_env }} (${{ matrix.os }}) | |
| runs-on: ${{ matrix.os }} | |
| env: | |
| MPLBACKEND: Agg | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - macos-latest | |
| - ubuntu-latest | |
| - windows-latest | |
| tox_env: | |
| - py38 | |
| - py39 | |
| - py310 | |
| - py311 | |
| include: | |
| - tox_env: py38 | |
| python: "3.8" | |
| - tox_env: py39 | |
| python: "3.9" | |
| - tox_env: py310 | |
| python: "3.10" | |
| - tox_env: py311 | |
| python: "3.11" | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install base python for tox | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9" | |
| - name: Install tox | |
| run: python -m pip install tox | |
| - name: Install python for test | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Setup test environment | |
| run: tox -vv --notest -e ${{ matrix.tox_env }} | |
| - name: Run test | |
| run: tox --skip-pkg-install -e ${{ matrix.tox_env }} | |
| - name: Upload coverage reports to Codecov | |
| if: success() || failure() | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| check: | |
| name: check ${{ matrix.tox_env }} (${{ matrix.os }}) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| tox_env: | |
| - flake8 | |
| - pylint | |
| - mypy | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install base python for tox | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9" | |
| - name: Install tox | |
| run: python -m pip install tox | |
| - name: Setup test environment | |
| run: tox -vv --notest -e ${{ matrix.tox_env }} | |
| - name: Run test | |
| run: tox --skip-pkg-install -e ${{ matrix.tox_env }} | |
| docs: | |
| name: docs (${{ matrix.os }}) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - macos-latest | |
| - ubuntu-latest | |
| - windows-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install pandoc | |
| uses: r-lib/actions/setup-pandoc@v2 | |
| with: | |
| pandoc-version: '2.19.2' | |
| - name: Install base python for tox | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.8" | |
| - name: Install tox | |
| run: python -m pip install tox | |
| - name: Setup test environment | |
| run: tox -vv --notest -e docs | |
| - name: Run test | |
| run: tox --skip-pkg-install -e docs | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: html-docs-${{ matrix.os }} | |
| path: docs/build/ |