actions / cache

Cache dependencies and build outputs in GitHub Actions
MIT License
4.39k stars 1.17k forks source link

Incorrect documentation for `restore-keys` #1173

Open Zac-HD opened 1 year ago

Zac-HD commented 1 year ago

https://github.com/actions/cache/blob/04f198bf0b2a39f7230a4304bf07747a0bddf146/README.md#L52

This turns out to be slightly but importantly wrong: the format is actually a multi-line string with one key per line; attempting to supply an actual list of keys will fail to validate (c.f. https://github.com/python/cpython/pull/104468#pullrequestreview-1425935982). I think the just updating the docs is probably better than switching to the currently-documented behavior.

github-actions[bot] commented 8 months ago

This issue is stale because it has been open for 200 days with no activity. Leave a comment to avoid closing this issue in 5 days.

Zac-HD commented 8 months ago

https://github.com/actions/cache/tree/main#inputs shows the same problem; the lack of a fix doesn't imply the issue should be closed.

github-actions[bot] commented 1 month ago

This issue is stale because it has been open for 200 days with no activity. Leave a comment to avoid closing this issue in 5 days.

Zac-HD commented 1 month ago

.

x612skm commented 1 week ago

Hi somebody please mind taking a look at this PR? @Zac-HD @webknjaz https://github.com/actions/cache/pull/1434