|
| 1 | +# Warm Python Dependency Cache |
| 2 | +# |
| 3 | +# Pre-downloads all Python dependencies via JFrog Artifactory and saves them |
| 4 | +# to the GitHub Actions cache. PR workflows (including fork PRs, which cannot |
| 5 | +# authenticate to JFrog) restore this cache and build fully offline. |
| 6 | +# |
| 7 | +# Triggers: |
| 8 | +# - push to main when dependency files change (keeps cache fresh) |
| 9 | +# - daily schedule (prevents 7-day GitHub Actions cache eviction) |
| 10 | +# - manual dispatch (with optional PR number to warm cache for a fork's deps) |
| 11 | + |
| 12 | +name: Warm Python Dependency Cache |
| 13 | + |
| 14 | +on: |
| 15 | + push: |
| 16 | + branches: [main] |
| 17 | + paths: |
| 18 | + - "uv.lock" |
| 19 | + - "pyproject.toml" |
| 20 | + - ".pre-commit-config.yaml" |
| 21 | + pull_request: # TEMPORARY: remove after testing |
| 22 | + schedule: |
| 23 | + - cron: "0 6 * * *" # Daily at 06:00 UTC |
| 24 | + workflow_dispatch: |
| 25 | + inputs: |
| 26 | + pr_number: |
| 27 | + description: "PR number to warm cache for (reads lockfiles from the PR branch). Leave empty to warm from main." |
| 28 | + required: false |
| 29 | + type: string |
| 30 | + |
| 31 | +permissions: |
| 32 | + id-token: write |
| 33 | + contents: read |
| 34 | + pull-requests: read |
| 35 | + |
| 36 | +jobs: |
| 37 | + warm-cache: |
| 38 | + runs-on: |
| 39 | + group: databricks-protected-runner-group |
| 40 | + labels: linux-ubuntu-latest |
| 41 | + |
| 42 | + env: |
| 43 | + UV_FROZEN: "1" |
| 44 | + # Pin cache dir so setup-uv doesn't override it to a temp path. |
| 45 | + # Must match the path in setup-python-deps/action.yml cache restore. |
| 46 | + UV_CACHE_DIR: /home/runner/.cache/uv |
| 47 | + |
| 48 | + steps: |
| 49 | + - name: Checkout main branch |
| 50 | + uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 |
| 51 | + |
| 52 | + - name: Overlay PR dependency files |
| 53 | + if: inputs.pr_number != '' |
| 54 | + shell: bash |
| 55 | + run: | |
| 56 | + set -euo pipefail |
| 57 | +
|
| 58 | + PR_DATA=$(curl -sLS \ |
| 59 | + -H "Accept: application/vnd.github+json" \ |
| 60 | + -H "Authorization: Bearer ${{ github.token }}" \ |
| 61 | + "https://api.github.com/repos/${{ github.repository }}/pulls/${{ inputs.pr_number }}") |
| 62 | +
|
| 63 | + FORK_REPO=$(echo "$PR_DATA" | jq -r '.head.repo.full_name') |
| 64 | + FORK_REF=$(echo "$PR_DATA" | jq -r '.head.ref') |
| 65 | +
|
| 66 | + echo "Warming cache for PR #${{ inputs.pr_number }} from ${FORK_REPO}@${FORK_REF}" |
| 67 | +
|
| 68 | + # Fetch only lockfiles from the fork — .github/actions/ always |
| 69 | + # comes from main to prevent code injection from forks. |
| 70 | + git remote add fork "https://github.com/${FORK_REPO}.git" |
| 71 | + git fetch --depth=1 fork "${FORK_REF}" |
| 72 | + git checkout FETCH_HEAD -- uv.lock pyproject.toml .pre-commit-config.yaml |
| 73 | +
|
| 74 | + - name: Setup JFrog PyPI Proxy |
| 75 | + uses: ./.github/actions/setup-jfrog-pypi |
| 76 | + |
| 77 | + - name: Set up Python |
| 78 | + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5 |
| 79 | + with: |
| 80 | + python-version: "3.10" |
| 81 | + |
| 82 | + - name: Install uv |
| 83 | + uses: astral-sh/setup-uv@38f3f104447c67c051c4a08e39b64a148898af3a # v4 |
| 84 | + |
| 85 | + - name: Install Hatch |
| 86 | + uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc # install |
| 87 | + |
| 88 | + - name: Install Python versions for test matrix |
| 89 | + run: uv python install 3.10 3.11 3.12 3.13 |
| 90 | + |
| 91 | + - name: Create all hatch environments (populates uv cache) |
| 92 | + run: | |
| 93 | + set -euo pipefail |
| 94 | + hatch env create default |
| 95 | + hatch env create test.py3.10 |
| 96 | + hatch env create test.py3.11 |
| 97 | + hatch env create test.py3.12 |
| 98 | + hatch env create test.py3.13 |
| 99 | + hatch env create verify |
| 100 | +
|
| 101 | + - name: Warm pre-commit cache |
| 102 | + run: hatch run pre-commit install-hooks |
| 103 | + |
| 104 | + - name: Build and warm pip cache for verify environment |
| 105 | + run: | |
| 106 | + set -euo pipefail |
| 107 | + hatch -v build |
| 108 | + # Run verify to populate ~/.cache/pip/ with runtime transitive deps. |
| 109 | + # Allow failure — we only care about populating the cache. |
| 110 | + hatch run verify:check-all || true |
| 111 | +
|
| 112 | + - name: Generate cache key |
| 113 | + id: cache-key |
| 114 | + shell: bash |
| 115 | + run: | |
| 116 | + # Hash first so consumers can prefix-match on the hash alone. |
| 117 | + # Timestamp suffix ensures each run creates a new immutable entry; |
| 118 | + # consumers pick the latest timestamp for a given hash. |
| 119 | + TIMESTAMP=$(date -u +%Y%m%d%H%M%S) |
| 120 | + LOCK_HASH="${{ hashFiles('uv.lock', 'pyproject.toml') }}" |
| 121 | + echo "python-deps-key=python-deps-${LOCK_HASH}-${TIMESTAMP}" >> "$GITHUB_OUTPUT" |
| 122 | +
|
| 123 | + PRECOMMIT_HASH="${{ hashFiles('.pre-commit-config.yaml') }}" |
| 124 | + echo "pre-commit-key=pre-commit-deps-${PRECOMMIT_HASH}-${TIMESTAMP}" >> "$GITHUB_OUTPUT" |
| 125 | +
|
| 126 | + - name: Save uv and pip cache |
| 127 | + uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4 |
| 128 | + with: |
| 129 | + path: | |
| 130 | + ~/.cache/uv |
| 131 | + ~/.cache/pip |
| 132 | + key: ${{ steps.cache-key.outputs.python-deps-key }} |
| 133 | + |
| 134 | + - name: Save pre-commit cache |
| 135 | + uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4 |
| 136 | + with: |
| 137 | + path: ~/.cache/pre-commit |
| 138 | + key: ${{ steps.cache-key.outputs.pre-commit-key }} |
0 commit comments