Skip to content

Enable caching of Python environments and pip download caches #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Enable caching of Python environments and pip download caches #610

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fea26b
build: experimental python env and pip caching
akaihola Aug 2, 2024
23d4d22
fix(ci): unify cache keys
akaihola Sep 1, 2025
a7d013d
fix(ci): add explicit bash shell for Windows compatibility in workflow
akaihola Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 97 additions & 2 deletions .github/workflows/python-package.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,37 @@ jobs:
cache-dependency-glob: |
**/setup.cfg
**/pyproject.toml

# 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-uv-cache
if: steps.python-cache.outputs.cache-hit != 'true'
shell: bash
run: echo "uv-cache-dir=$(uv cache dir)" >> ${GITHUB_OUTPUT}
- name: "Cache uv"
if: steps.python-cache.outputs.cache-hit != 'true'
uses: actions/cache@v4
with:
path: ${{steps.get-uv-cache.outputs.uv-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: Build wheel distribution
run: |
uv build --wheel
Expand Down Expand Up @@ -119,7 +150,8 @@ jobs:
with:
fetch-depth: 0
# need full history since Pytest runs Darker itself below
- name: Set up Python ${{ matrix.python-version }}
- id: setup-python
name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
Expand All @@ -128,6 +160,37 @@ jobs:
with:
python-version: ${{ matrix.python-version }}
activate-environment: true

# 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-uv-cache
if: steps.python-cache.outputs.cache-hit != 'true'
shell: bash
run: echo "uv-cache-dir=$(uv cache dir)" >> ${GITHUB_OUTPUT}
- name: "Cache uv"
if: steps.python-cache.outputs.cache-hit != 'true'
uses: actions/cache@v4
with:
path: ${{steps.get-uv-cache.outputs.uv-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@v4
- name: Install Darker and its dependencies from the wheel built earlier
Expand All @@ -153,9 +216,41 @@ jobs:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v6
- uses: actions/setup-python@v5
- id: setup-python
uses: actions/setup-python@v5
with:
python-version: 3.x

# 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-uv-cache
if: steps.python-cache.outputs.cache-hit != 'true'
shell: bash
run: echo "uv-cache-dir=$(uv cache dir)" >> ${GITHUB_OUTPUT}
- name: "Cache uv"
if: steps.python-cache.outputs.cache-hit != 'true'
uses: actions/cache@v4
with:
path: ${{steps.get-uv-cache.outputs.uv-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@v4
- name: Build source distribution
Expand Down
Loading