actions / actions/toolkit

Tool-Cache should support semver beta/alpha versions and non-semver dependencies

Open
#709 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement tool-cache
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

If your issue is relevant to this repository, please include the information below:

Describe the enhancement
Currently, the toolcache only works for semver. Some users may want to opt into storing and retrieving preview/beta versions of dependencies, we should look on how we can support those flows so that those versions can be reused during workflows.

Code Snippet

Ideally, we would support beta/alpha versions, and let users opt in or out when using find so you could do something like

    await tc.cacheFile(downloadPath, 'foo', 'foo', '1.1.0-beta')
    const toolPath: string = tc.find('foo', '1.1.x' {allowPreview: true})

https://github.com/actions/toolkit/pull/698

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 by tracing the tool-cache entry points named in the issue: cacheFile and find. Review how versions are currently matched and stored, then define behavior for beta/alpha and non-semver dependencies, including the proposed allowPreview option. Done should include opt-in retrieval of preview versions while preserving existing semver behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
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.