Enable caching of Python environments and pip download caches #2331
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 and test | |
| on: # yamllint disable-line rule:truthy | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| env: | |
| PY_IGNORE_IMPORTMISMATCH: 1 | |
| jobs: | |
| build-wheel: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| wheel-path: ${{ steps.get-darker-version.outputs.wheel-path }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - id: setup-python | |
| uses: actions/setup-python@v5 | |
| # PYTHON CACHING: | |
| - id: python-cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ${{ env.pythonLocation }}/lib | |
| ${{ env.pythonLocation }}/bin | |
| key: > | |
| os${{ runner.os }}- | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| req${{ hashFiles('setup.cfg') }} | |
| - id: get-pip-cache | |
| if: steps.python-cache.outputs.cache-hit != 'true' | |
| run: echo "pip-cache-dir=$(pip cache dir)" >> ${GITHUB_OUTPUT} | |
| - name: "Cache pip" | |
| if: steps.python-cache.outputs.cache-hit != 'true' | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{steps.get-pip-cache.outputs.pip-cache-dir}} | |
| key: > | |
| os${{ runner.os }}- | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| req${{ hashFiles('setup.cfg') }} | |
| restore-keys: "\ | |
| os${{ runner.os }}-\ | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| os${{ runner.os }}- | |
| " | |
| # END PYTHON CACHING | |
| - name: Install wheel | |
| run: python -m pip install wheel | |
| - name: Build wheel distribution | |
| run: python setup.py bdist_wheel | |
| - name: Upload wheel for other jobs | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist/ | |
| if-no-files-found: error | |
| - name: Find out Darker version and output it for test jobs | |
| id: get-darker-version | |
| shell: python | |
| run: | | |
| from os import environ | |
| from pathlib import Path | |
| from runpy import run_path | |
| version = run_path("src/darker/version.py")["__version__"] | |
| Path(environ["GITHUB_OUTPUT"]).open("a").write( | |
| f"wheel-path=dist/darker-{version}-py3-none-any.whl\n" | |
| ) | |
| test-nixos: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| - macos-latest | |
| needs: | |
| - build-wheel | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: cachix/install-nix-action@v22 | |
| with: | |
| nix_path: nixpkgs=channel:nixos-unstable | |
| - name: Download wheel uploaded by the build-wheel job | |
| uses: actions/download-artifact@v3 | |
| - name: Run tests in nix-shell | |
| run: | | |
| nix-shell \ | |
| --pure \ | |
| --run ' | |
| python -m venv venv | |
| source venv/bin/activate | |
| cert_file=/nix/var/nix/profiles/default/etc/ssl/certs/ca-bundle.crt | |
| export NIX_SSL_CERT_FILE=$cert_file | |
| pip install "${{needs.build-wheel.outputs.wheel-path}}[test]" | |
| # Run tests in installed package to avoid plugin import issue: | |
| pytest $(python -c " | |
| import os, darker | |
| print(os.path.dirname(darker.__file__)) | |
| ") | |
| ' \ | |
| ./default.nix | |
| test: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| - windows-latest | |
| - macos-latest | |
| python-version: | |
| - '3.8' | |
| - '3.9' | |
| - '3.10' | |
| - '3.11' | |
| - '3.12' | |
| - '3.13-dev' | |
| constraints: [''] | |
| post_install: [''] | |
| exclude: | |
| # C extension builds failing. | |
| # Remove exclusions after Python 3.13 release. | |
| - os: windows-latest | |
| python-version: '3.13-dev' | |
| - os: macos-latest | |
| python-version: '3.13-dev' | |
| include: | |
| - os: ubuntu-latest | |
| python-version: '3.8' | |
| constraints: '--constraint constraints-oldest.txt' | |
| - os: ubuntu-latest | |
| python-version: '3.12' | |
| post_install: pip uninstall -y -r constraints-future.txt ; | |
| pip install -r constraints-future.txt | |
| --upgrade --upgrade-strategy=eager | |
| needs: | |
| - build-wheel | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| # need full history since Pytest runs Darker itself below | |
| - id: setup-python | |
| name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| # PYTHON CACHING: | |
| - id: python-cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ${{ env.pythonLocation }}/lib | |
| ${{ env.pythonLocation }}/bin | |
| key: > | |
| os${{ runner.os }}- | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| req${{ hashFiles('setup.cfg') }} | |
| - id: get-pip-cache | |
| if: steps.python-cache.outputs.cache-hit != 'true' | |
| run: echo "pip-cache-dir=$(pip cache dir)" >> ${GITHUB_OUTPUT} | |
| - name: "Cache pip" | |
| if: steps.python-cache.outputs.cache-hit != 'true' | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{steps.get-pip-cache.outputs.pip-cache-dir}} | |
| key: > | |
| os${{ runner.os }}- | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| req${{ hashFiles('setup.cfg') }} | |
| restore-keys: "\ | |
| os${{ runner.os }}-\ | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| os${{ runner.os }}- | |
| " | |
| # END PYTHON CACHING | |
| - name: Download wheel uploaded by the build-wheel job | |
| uses: actions/download-artifact@v3 | |
| - name: Install Darker and its dependencies from the wheel built earlier | |
| run: pip install "${{needs.build-wheel.outputs.wheel-path}}[test]" | |
| ${{ matrix.upgrade }} ${{ matrix.constraints }} | |
| - name: Upgrade Black, Flynt and Isort from GitHub if future constraints are used | |
| # This can't be done in the same Pip invocation as installing Darker | |
| # since Darker might place an upper limit on Black, Flynt and/or Isort during | |
| # compatibility fixing periods. | |
| if: matrix.post_install | |
| run: ${{ matrix.post_install }} | |
| - name: Downgrade target-version when running oldest supported Black | |
| if: matrix.constraints == '--constraint constraints-oldest.txt' | |
| run: | | |
| sed -i 's/, "py311", "py312"//' pyproject.toml | |
| - run: pytest | |
| build-sdist-validate-dists: | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build-wheel | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - id: setup-python | |
| uses: actions/setup-python@v5 | |
| # PYTHON CACHING: | |
| - id: python-cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ${{ env.pythonLocation }}/lib | |
| ${{ env.pythonLocation }}/bin | |
| key: > | |
| os${{ runner.os }}- | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| req${{ hashFiles('setup.cfg') }} | |
| - id: get-pip-cache | |
| if: steps.python-cache.outputs.cache-hit != 'true' | |
| run: echo "pip-cache-dir=$(pip cache dir)" >> ${GITHUB_OUTPUT} | |
| - name: "Cache pip" | |
| if: steps.python-cache.outputs.cache-hit != 'true' | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{steps.get-pip-cache.outputs.pip-cache-dir}} | |
| key: > | |
| os${{ runner.os }}- | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| req${{ hashFiles('setup.cfg') }} | |
| restore-keys: "\ | |
| os${{ runner.os }}-\ | |
| py${{ steps.setup-python.outputs.python-version }}- | |
| os${{ runner.os }}- | |
| " | |
| # END PYTHON CACHING | |
| - name: Install twine | |
| run: python -m pip install twine | |
| - name: Download wheel uploaded by the build-wheel job | |
| uses: actions/download-artifact@v3 | |
| - name: Build source distribution | |
| run: python setup.py sdist | |
| - name: Validate distributions | |
| run: twine check dist/* |