Use Restore Keys for Fallback Cache Matching
Configure cache restore keys so a partial key match still reuses a previous cache when the exact key misses.
Task
Automate actions/cache@v4 with: restore-keys: node-${{ runner.os }}- so pipeline failures are caught before merge and never reach production.
When to use this
A pull request merges with a broken actions/cache@v4 with: restore-keys: node-${{ runner.os }}- step because the workflow did not gate on it, causing a failed deploy.
Prerequisites
- Node.js 22 and pnpm available
- A CI workflow file in .github/workflows
Steps
1. Configure actions/cache@v4 with: restore-keys: node-${{ runner.os }}- in the project configuration file with the recommended defaults.
actions/cache@v4 with: restore-keys: node-${{ runner.os }}-
Expected output: The configuration is accepted and actions/cache@v4 with: restore-keys: node-${{ runner.os }}- runs without errors on the first invocation.
2. Run the check locally to verify actions/cache@v4 with: restore-keys: node-${{ runner.os }}- produces the expected result before pushing.
act -j build # or: pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so actions/cache@v4 with: restore-keys: node-${{ runner.os }}- blocks merge on failure.
- name: Run add pipeline cache restore keys
run: pnpm test
Expected output: Pull requests with failing actions/cache@v4 with: restore-keys: node-${{ runner.os }}- are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Gate the pipeline before merge
Start by measuring the problem. Configure cache restore keys so a partial key match still reuses a previous cache when the exact key misses. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run actions/cache@v4 with: restore-keys: node-${{ runner.os }}- against the current codebase and inspect the output before wiring it into CI.
actions/cache@v4 with: restore-keys: node-${{ runner.os }}-Make failures actionable
Once the gate is in place, make failures actionable. A failing actions/cache@v4 with: restore-keys: node-${{ runner.os }}- should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.