fix reference to readme #2
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: Build | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: [opened, synchronize, reopened, edited] | |
| workflow_dispatch: | |
| jobs: | |
| code-quality: | |
| name: Code Quality | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out | |
| uses: actions/checkout@v3 | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Set up the environment | |
| uses: ./.github/actions/setup-poetry-env | |
| - name: Run checks | |
| run: poetry run invoke check | |
| run-tests: | |
| runs-on: ubuntu-latest | |
| name: Tests | |
| strategy: | |
| matrix: | |
| python-version: ['3.8', '3.9', '3.10', '3.11'] | |
| fail-fast: false | |
| steps: | |
| - name: Check out | |
| uses: actions/checkout@v3 | |
| - name: Set up python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| - name: Load cached venv | |
| uses: actions/cache@v3 | |
| with: | |
| path: .tox | |
| key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }} | |
| - name: Install tox | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install tox tox-gh-actions | |
| - name: Test with tox | |
| run: tox | |
| - name: Upload coverage reports to Codecov with GitHub Action on Python 3.11 | |
| uses: codecov/codecov-action@v3 | |
| if: ${{ matrix.python-version == '3.11' }} | |
| # check-docs: | |
| # name: Check Documentation | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - name: Check out | |
| # uses: actions/checkout@v3 | |
| # # - name: Set up the environment | |
| # # uses: ./.github/actions/setup-poetry-env | |
| # - name: Install Poetry | |
| # uses: snok/install-poetry@v1 | |
| # - name: Load cached venv | |
| # uses: actions/cache@v3 | |
| # with: | |
| # path: .tox | |
| # key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }} | |
| # - name: Check if documentation can be built | |
| # run: poetry run invoke docs |