Skip to content

feat: configure caller caches #633

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

Merged
rapids-bot merged 7 commits into from
Sep 10, 2026
Merged

feat: configure caller caches #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5cbcaac
fix: hash multiline caller cache key files
vyasr Sep 9, 2026
3dd7d3a
fix: restore caller caches without saving
vyasr Sep 9, 2026
e01ca11
Revert "fix: restore caller caches without saving"
vyasr Sep 9, 2026
bc674bb
feat: support read-only caller caches
vyasr Sep 9, 2026
f78ccb8
feat: configure caller cache matrix keys
vyasr Sep 9, 2026
3d65113
refactor: reuse caller cache setup action
vyasr Sep 10, 2026
8a039e5
ci: use released caller cache action
vyasr Sep 10, 2026
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
49 changes: 28 additions & 21 deletions .github/workflows/conda-cpp-build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,33 @@ on:
required: false
default: ""
description: |
Newline-separated files or glob patterns to hash into the cache key. Use this for caches
Newline-separated tracked files or glob patterns to hash into the cache key. Use this for caches
that must be saved again when relevant source or dependency files change.
cache-key-matrix-fields:
type: string
required: false
default: |
CUDA_VER
PY_VER
ARCH
LINUX_VER
description: |
Newline-separated matrix fields that scope the caller cache key. Override only when the
cache is known to be independent of one of this workflow's default compatibility fields.
cache-environment:
type: string
required: false
default: ""
description: |
Newline-separated literal NAME=VALUE pairs exported before the caller script runs.
Use workspace-relative paths for directories managed by cache-paths.
cache-read-only:
type: boolean
required: false
default: false
description: |
Restore caller cache paths without saving them at job completion. Use this for
short-lived refs that should consume a cache maintained by a trusted ref.

defaults:
run:
Expand Down Expand Up @@ -151,28 +169,17 @@ jobs:
ref: ${{ inputs.sha }}
fetch-depth: 0
persist-credentials: true
- name: Validate caller cache configuration
- name: Setup caller cache
if: inputs.cache-paths != '' || inputs.cache-key-prefix != '' || inputs.cache-key-files != '' || inputs.cache-environment != ''
run: |
if test -z "${INPUTS_CACHE_PATHS}" || test -z "${INPUTS_CACHE_KEY_PREFIX}"; then
echo "ERROR: cache-paths and cache-key-prefix must be provided together."
exit 1
fi
env:
INPUTS_CACHE_PATHS: ${{ inputs.cache-paths }}
INPUTS_CACHE_KEY_PREFIX: ${{ inputs.cache-key-prefix }}
- name: Cache caller paths
if: inputs.cache-paths != ''
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
uses: rapidsai/shared-actions/setup-caller-cache@main
with:
path: ${{ inputs.cache-paths }}
key: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-${{ hashFiles(inputs.cache-key-files) }}
restore-keys: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-
- name: Configure caller cache environment
if: inputs.cache-environment != ''
run: printf '%s\n' "$INPUTS_CACHE_ENVIRONMENT" >> "$GITHUB_ENV"
env:
INPUTS_CACHE_ENVIRONMENT: ${{ inputs.cache-environment }}
cache-paths: ${{ inputs.cache-paths }}
cache-key-prefix: ${{ inputs.cache-key-prefix }}
cache-key-files: ${{ inputs.cache-key-files }}
cache-key-matrix-fields: ${{ inputs.cache-key-matrix-fields }}
cache-environment: ${{ inputs.cache-environment }}
cache-read-only: ${{ inputs.cache-read-only }}
matrix: ${{ toJSON(matrix) }}
- name: Standardize repository information
env:
RAPIDS_REPOSITORY: ${{ inputs.repo || github.repository }}
Expand Down
53 changes: 31 additions & 22 deletions .github/workflows/conda-cpp-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,36 @@ on:
required: false
default: ""
description: |
Newline-separated files or glob patterns to hash into the cache key. Use this for caches
Newline-separated tracked files or glob patterns to hash into the cache key. Use this for caches
that must be saved again when relevant source or dependency files change.
cache-key-matrix-fields:
type: string
required: false
default: |
CUDA_VER
PY_VER
ARCH
LINUX_VER
GPU
DRIVER
DEPENDENCIES
description: |
Newline-separated matrix fields that scope the caller cache key. Override only when the
cache is known to be independent of one of this workflow's default compatibility fields.
cache-environment:
type: string
required: false
default: ""
description: |
Newline-separated literal NAME=VALUE pairs exported before the caller script runs.
Use workspace-relative paths for directories managed by cache-paths.
cache-read-only:
type: boolean
required: false
default: false
description: |
Restore caller cache paths without saving them at job completion. Use this for
short-lived refs that should consume a cache maintained by a trusted ref.
secrets:
script-env-secret-1-key:
description: |
Expand Down Expand Up @@ -193,29 +214,17 @@ jobs:
ref: ${{ inputs.sha }}
fetch-depth: 0
persist-credentials: true
- name: Validate caller cache configuration
- name: Setup caller cache
if: inputs.cache-paths != '' || inputs.cache-key-prefix != '' || inputs.cache-key-files != '' || inputs.cache-environment != ''
run: |
if test -z "${INPUTS_CACHE_PATHS}" || test -z "${INPUTS_CACHE_KEY_PREFIX}"; then
echo "ERROR: cache-paths and cache-key-prefix must be provided together."
exit 1
fi
env:
INPUTS_CACHE_PATHS: ${{ inputs.cache-paths }}
INPUTS_CACHE_KEY_PREFIX: ${{ inputs.cache-key-prefix }}
- name: Cache caller paths
if: inputs.cache-paths != ''
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
uses: rapidsai/shared-actions/setup-caller-cache@main
with:
path: ${{ inputs.cache-paths }}
key: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-${{ matrix.GPU }}-${{ matrix.DRIVER }}-${{ matrix.DEPENDENCIES }}-${{ hashFiles(inputs.cache-key-files) }}
restore-keys: |
${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-${{ matrix.GPU }}-${{ matrix.DRIVER }}-${{ matrix.DEPENDENCIES }}-
- name: Configure caller cache environment
if: inputs.cache-environment != ''
run: printf '%s\n' "$INPUTS_CACHE_ENVIRONMENT" >> "$GITHUB_ENV"
env:
INPUTS_CACHE_ENVIRONMENT: ${{ inputs.cache-environment }}
cache-paths: ${{ inputs.cache-paths }}
cache-key-prefix: ${{ inputs.cache-key-prefix }}
cache-key-files: ${{ inputs.cache-key-files }}
cache-key-matrix-fields: ${{ inputs.cache-key-matrix-fields }}
cache-environment: ${{ inputs.cache-environment }}
cache-read-only: ${{ inputs.cache-read-only }}
matrix: ${{ toJSON(matrix) }}
# This has to be AFTER the checkout step. It creates a telemetry-artifacts directory,
# and the checkout step would destroy it.
- name: Telemetry setup
Expand Down
49 changes: 28 additions & 21 deletions .github/workflows/conda-python-build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,33 @@ on:
required: false
default: ""
description: |
Newline-separated files or glob patterns to hash into the cache key. Use this for caches
Newline-separated tracked files or glob patterns to hash into the cache key. Use this for caches
that must be saved again when relevant source or dependency files change.
cache-key-matrix-fields:
type: string
required: false
default: |
CUDA_VER
PY_VER
ARCH
LINUX_VER
description: |
Newline-separated matrix fields that scope the caller cache key. Override only when the
cache is known to be independent of one of this workflow's default compatibility fields.
cache-environment:
type: string
required: false
default: ""
description: |
Newline-separated literal NAME=VALUE pairs exported before the caller script runs.
Use workspace-relative paths for directories managed by cache-paths.
cache-read-only:
type: boolean
required: false
default: false
description: |
Restore caller cache paths without saving them at job completion. Use this for
short-lived refs that should consume a cache maintained by a trusted ref.

defaults:
run:
Expand Down Expand Up @@ -161,28 +179,17 @@ jobs:
ref: ${{ inputs.sha }}
fetch-depth: 0
persist-credentials: true
- name: Validate caller cache configuration
- name: Setup caller cache
if: inputs.cache-paths != '' || inputs.cache-key-prefix != '' || inputs.cache-key-files != '' || inputs.cache-environment != ''
run: |
if test -z "${INPUTS_CACHE_PATHS}" || test -z "${INPUTS_CACHE_KEY_PREFIX}"; then
echo "ERROR: cache-paths and cache-key-prefix must be provided together."
exit 1
fi
env:
INPUTS_CACHE_PATHS: ${{ inputs.cache-paths }}
INPUTS_CACHE_KEY_PREFIX: ${{ inputs.cache-key-prefix }}
- name: Cache caller paths
if: inputs.cache-paths != ''
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
uses: rapidsai/shared-actions/setup-caller-cache@main
with:
path: ${{ inputs.cache-paths }}
key: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-${{ hashFiles(inputs.cache-key-files) }}
restore-keys: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-
- name: Configure caller cache environment
if: inputs.cache-environment != ''
run: printf '%s\n' "$INPUTS_CACHE_ENVIRONMENT" >> "$GITHUB_ENV"
env:
INPUTS_CACHE_ENVIRONMENT: ${{ inputs.cache-environment }}
cache-paths: ${{ inputs.cache-paths }}
cache-key-prefix: ${{ inputs.cache-key-prefix }}
cache-key-files: ${{ inputs.cache-key-files }}
cache-key-matrix-fields: ${{ inputs.cache-key-matrix-fields }}
cache-environment: ${{ inputs.cache-environment }}
cache-read-only: ${{ inputs.cache-read-only }}
matrix: ${{ toJSON(matrix) }}
- name: Standardize repository information
env:
RAPIDS_REPOSITORY: ${{ inputs.repo || github.repository }}
Expand Down
53 changes: 31 additions & 22 deletions .github/workflows/conda-python-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,36 @@ on:
required: false
default: ""
description: |
Newline-separated files or glob patterns to hash into the cache key. Use this for caches
Newline-separated tracked files or glob patterns to hash into the cache key. Use this for caches
that must be saved again when relevant source or dependency files change.
cache-key-matrix-fields:
type: string
required: false
default: |
CUDA_VER
PY_VER
ARCH
LINUX_VER
GPU
DRIVER
DEPENDENCIES
description: |
Newline-separated matrix fields that scope the caller cache key. Override only when the
cache is known to be independent of one of this workflow's default compatibility fields.
cache-environment:
type: string
required: false
default: ""
description: |
Newline-separated literal NAME=VALUE pairs exported before the caller script runs. Use
workspace-relative paths for directories managed by cache-paths.
cache-read-only:
type: boolean
required: false
default: false
description: |
Restore caller cache paths without saving them at job completion. Use this for
short-lived refs that should consume a cache maintained by a trusted ref.
secrets:
script-env-secret-1-key:
description: |
Expand Down Expand Up @@ -208,29 +229,17 @@ jobs:
fetch-depth: 0
persist-credentials: true

- name: Validate caller cache configuration
- name: Setup caller cache
if: inputs.cache-paths != '' || inputs.cache-key-prefix != '' || inputs.cache-key-files != '' || inputs.cache-environment != ''
run: |
if test -z "${INPUTS_CACHE_PATHS}" || test -z "${INPUTS_CACHE_KEY_PREFIX}"; then
echo "ERROR: cache-paths and cache-key-prefix must be provided together."
exit 1
fi
env:
INPUTS_CACHE_PATHS: ${{ inputs.cache-paths }}
INPUTS_CACHE_KEY_PREFIX: ${{ inputs.cache-key-prefix }}
- name: Cache caller paths
if: inputs.cache-paths != ''
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
uses: rapidsai/shared-actions/setup-caller-cache@main
with:
path: ${{ inputs.cache-paths }}
key: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-${{ matrix.GPU }}-${{ matrix.DRIVER }}-${{ matrix.DEPENDENCIES }}-${{ hashFiles(inputs.cache-key-files) }}
restore-keys: |
${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-${{ matrix.GPU }}-${{ matrix.DRIVER }}-${{ matrix.DEPENDENCIES }}-
- name: Configure caller cache environment
if: inputs.cache-environment != ''
run: printf '%s\n' "$INPUTS_CACHE_ENVIRONMENT" >> "$GITHUB_ENV"
env:
INPUTS_CACHE_ENVIRONMENT: ${{ inputs.cache-environment }}
cache-paths: ${{ inputs.cache-paths }}
cache-key-prefix: ${{ inputs.cache-key-prefix }}
cache-key-files: ${{ inputs.cache-key-files }}
cache-key-matrix-fields: ${{ inputs.cache-key-matrix-fields }}
cache-environment: ${{ inputs.cache-environment }}
cache-read-only: ${{ inputs.cache-read-only }}
matrix: ${{ toJSON(matrix) }}

- name: Standardize repository information
uses: rapidsai/shared-actions/rapids-github-info@main
Expand Down
49 changes: 28 additions & 21 deletions .github/workflows/wheels-build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,15 +128,33 @@ on:
required: false
default: ""
description: |
Newline-separated files or glob patterns to hash into the cache key. Use this for caches
Newline-separated tracked files or glob patterns to hash into the cache key. Use this for caches
that must be saved again when relevant source or dependency files change.
cache-key-matrix-fields:
type: string
required: false
default: |
CUDA_VER
PY_VER
ARCH
LINUX_VER
description: |
Newline-separated matrix fields that scope the caller cache key. Override only when the
cache is known to be independent of one of this workflow's default compatibility fields.
cache-environment:
type: string
required: false
default: ""
description: |
Newline-separated literal NAME=VALUE pairs exported before the caller script runs.
Use workspace-relative paths for directories managed by cache-paths.
cache-read-only:
type: boolean
required: false
default: false
description: |
Restore caller cache paths without saving them at job completion. Use this for
short-lived refs that should consume a cache maintained by a trusted ref.

defaults:
run:
Expand Down Expand Up @@ -194,28 +212,17 @@ jobs:
fetch-depth: 0
persist-credentials: false

- name: Validate caller cache configuration
- name: Setup caller cache
if: inputs.cache-paths != '' || inputs.cache-key-prefix != '' || inputs.cache-key-files != '' || inputs.cache-environment != ''
run: |
if test -z "${INPUTS_CACHE_PATHS}" || test -z "${INPUTS_CACHE_KEY_PREFIX}"; then
echo "ERROR: cache-paths and cache-key-prefix must be provided together."
exit 1
fi
env:
INPUTS_CACHE_PATHS: ${{ inputs.cache-paths }}
INPUTS_CACHE_KEY_PREFIX: ${{ inputs.cache-key-prefix }}
- name: Cache caller paths
if: inputs.cache-paths != ''
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
uses: rapidsai/shared-actions/setup-caller-cache@main
with:
path: ${{ inputs.cache-paths }}
key: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-${{ hashFiles(inputs.cache-key-files) }}
restore-keys: ${{ inputs.cache-key-prefix }}-${{ matrix.CUDA_VER }}-${{ matrix.PY_VER }}-${{ matrix.ARCH }}-${{ matrix.LINUX_VER }}-
- name: Configure caller cache environment
if: inputs.cache-environment != ''
run: printf '%s\n' "$INPUTS_CACHE_ENVIRONMENT" >> "$GITHUB_ENV"
env:
INPUTS_CACHE_ENVIRONMENT: ${{ inputs.cache-environment }}
cache-paths: ${{ inputs.cache-paths }}
cache-key-prefix: ${{ inputs.cache-key-prefix }}
cache-key-files: ${{ inputs.cache-key-files }}
cache-key-matrix-fields: ${{ inputs.cache-key-matrix-fields }}
cache-environment: ${{ inputs.cache-environment }}
cache-read-only: ${{ inputs.cache-read-only }}
matrix: ${{ toJSON(matrix) }}

- name: Standardize repository information
uses: rapidsai/shared-actions/rapids-github-info@main
Expand Down
Loading