actions / actions/cache

Rename `restore-keys` to `fallback-keys` or `backup-keys` or `partial-restore-keys`

Open
#1,590 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5.6k
Forks
1.6k
PR merge metrics
No merged PRs in 30d

Description

Several users are confused about what restore-keys actually does or in what contexts it should be used.

See this StackOverflow Q&A.

A more intuitive name would be fallback-keys, backup-keys, or partial-restore-keys.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Stack Overflow Q&A and the issue discussion to understand the confusion around restore-keys. Then locate the cache action input and its documentation, determine which proposed name is appropriate, and define completion as a consistent rename with any necessary compatibility decisions documented and tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.