Add documentation #50
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: CI | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| coverage: | |
| name: "Coverage" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout sources" | |
| uses: actions/checkout@v3 | |
| - name: "Set up Python 3.8" | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.8" | |
| - name: "Install dependencies" | |
| run: | | |
| python -m pip install --upgrade pip | |
| # tox version: https://github.com/tox-dev/tox/issues/2778 | |
| python -m pip install coveralls tox==3.28.0 | |
| - name: "Check code coverage" | |
| run: | | |
| tox -e coverage | |
| - name: "Coveralls" | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| coveralls --service=github | |
| lint: | |
| name: "Code style" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout sources" | |
| uses: actions/checkout@v3 | |
| - name: "Set up Python ${{ matrix.python-version }}" | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "${{ matrix.python-version }}" | |
| - name: "Install dependencies" | |
| run: | | |
| python -m pip install --upgrade pip | |
| # tox version: https://github.com/tox-dev/tox/issues/2778 | |
| python -m pip install tox==3.28.0 | |
| - name: "Test with tox for ${{ matrix.os }}" | |
| run: | | |
| tox -e lint | |
| test: | |
| name: "Test ${{ matrix.os }} with python-${{ matrix.python-version }}" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| python-version: ["3.8", "3.9", "3.10"] | |
| steps: | |
| - name: "Checkout sources" | |
| uses: actions/checkout@v3 | |
| - name: "Set up Python ${{ matrix.python-version }}" | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "${{ matrix.python-version }}" | |
| - name: "Install dependencies" | |
| run: | | |
| python -m pip install --upgrade pip | |
| # tox version: https://github.com/tox-dev/tox/issues/2778 | |
| python -m pip install tox==3.28.0 tox-gh-actions | |
| - name: "Test with tox for ${{ matrix.os }}" | |
| run: | | |
| tox | |
| env: | |
| PLATFORM: ${{ matrix.os }} | |
| ci_success: | |
| name: "CI success" | |
| runs-on: ubuntu-latest | |
| needs: [coverage, lint, test] | |
| steps: | |
| - run: echo "CI workflow completed successfully" |