Document that the tool-cache library does not cache tools between runs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
The tool-cache library readme should make it clear that it doesn't cache tools between runs on hosted runners. This is hinted at by the phrase "This is useful if you want to ... save a tool between runs for self-hosted runners" but it is not explicitly stated.
As library written by Github, it seems like using the tool-cache would be the best way of creating a re-usable action to install a binary. However it's utility for tools that aren't pre-installed in runner images is small and it's name is misleading.
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
Open the tool-cache library README referenced in the issue and review the existing sentence about saving tools between runs for self-hosted runners. Update the documentation to state explicitly that hosted runners do not cache tools between runs; the issue mentions no test or additional file to run.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100