Add cache func #56
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: Poetry test | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| jobs: | |
| linting: | |
| runs-on: ubuntu-latest | |
| steps: | |
| #---------------------------------------------- | |
| # check-out repo and set-up python | |
| #---------------------------------------------- | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| #---------------------------------------------- | |
| # load pip cache if cache exists | |
| #---------------------------------------------- | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip | |
| restore-keys: ${{ runner.os }}-pip | |
| #---------------------------------------------- | |
| # install and run linters | |
| #---------------------------------------------- | |
| - run: python -m pip install black flake8 isort | |
| - run: | | |
| # stop the build if there are Python syntax errors or undefined names | |
| flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | |
| # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | |
| flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --extend-ignore=E203,F401 | |
| black . --check | |
| isort . | |
| test: | |
| needs: linting | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| os: ["ubuntu-latest"] #, "macos-latest"] | |
| python-version: ["3.10", "3.11", "3.12"] | |
| # django-version: ["4", "5"] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| #---------------------------------------------- | |
| # check-out repo and set-up python | |
| #---------------------------------------------- | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - name: Set up python ${{ matrix.python-version }} | |
| id: setup-python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| #---------------------------------------------- | |
| # load cached Poetry installation | |
| #---------------------------------------------- | |
| - name: Load cached Poetry installation | |
| id: cached-poetry | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.local # the path depends on the OS | |
| key: poetry-0 # increment to reset cache | |
| #---------------------------------------------- | |
| # ----- install & configure poetry ----- | |
| #---------------------------------------------- | |
| - name: Install Poetry | |
| if: steps.cached-poetry.outputs.cache-hit != 'true' | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| #---------------------------------------------- | |
| # install & configure Graphviz | |
| #---------------------------------------------- | |
| - name: Install Graphviz | |
| run: sudo apt-get update && sudo apt-get install -y graphviz | |
| #---------------------------------------------- | |
| # load cached venv if cache exists | |
| #---------------------------------------------- | |
| - name: Load cached venv | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} | |
| #---------------------------------------------- | |
| # install dependencies if cache does not exist | |
| #---------------------------------------------- | |
| - name: Install dependencies | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| run: poetry install --no-interaction --no-root | |
| #---------------------------------------------- | |
| # install your root project, if required | |
| #---------------------------------------------- | |
| - name: Install library | |
| run: poetry install --no-interaction | |
| #---------------------------------------------- | |
| # add matrix specifics and run test suite | |
| #---------------------------------------------- | |
| # - name: Install django ${{ matrix.django-version }} | |
| # run: | | |
| # source .venv/bin/activate | |
| # pip install "Django==${{ matrix.django-version }}" | |
| - name: Run tests | |
| run: | | |
| source .venv/bin/activate | |
| pytest tests/ --cov=./ --cov-report=xml | |
| coverage report | |
| #---------------------------------------------- | |
| # upload coverage stats | |
| # (requires CODECOV_TOKEN in repository secrets) | |
| #---------------------------------------------- | |
| - name: Upload coverage | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| # token: ${{ secrets.CODECOV_TOKEN }} # Only required for private repositories | |
| file: ./coverage.xml | |
| fail_ci_if_error: true |