4 add readthedocs #18
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
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | |
| name: tests | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| jobs: | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] #, windows-latest, macos-latest] # Extend to your needs | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] # Extend to your needs | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: "pip" # caching pip dependencies | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install poetry | |
| python -m poetry install | |
| - name: Lint with flake8 | |
| run: | | |
| # stop the build if there are Python syntax errors or undefined names | |
| python -m poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | |
| # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | |
| python -m poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | |
| # TODO adapt package_name to the name of your package | |
| - name: Test with pytest | |
| run: | | |
| python -m poetry run pytest --cov package_name | |
| # Add the following block to upload coverage to Codecov, requires a CODECOV_TOKEN secret to be set in the repository | |
| # - name: Upload results to Codecov | |
| # # Only upload to Codecov after a merge to the main branch | |
| # if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| # uses: codecov/codecov-action@v4 | |
| # with: | |
| # token: ${{ secrets.CODECOV_TOKEN }} |