doc: need to document limits on cache keys
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.6k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
I was trying to use ${{ github.head_ref }} as part of a cache key, however this ends up with:
with:
…
key: git-main-CLDR-17028-Add-test-for-person-names,-and-regenerated-files
restore-keys: git-main-CLDR-17028-Add-test-for-person-names,-and-regenerated-files
causes:
Error: Key Validation Error: git-main-CLDR-17028-Add-test-for-person-names,-and-regenerated-files cannot contain commas
I see this in the tests and underlying library, but is it documented where the limitations on cache keys are?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the cache-key validation tests and underlying library referenced in the issue, starting with the comma restriction shown in the error. Document the supported cache-key limits and an example of the affected GitHub Actions expression; the work is done when users can find and understand those constraints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100