software-mansion / setup-scarb Goto Github PK

Related to this comment under setup-bun.

Right now sha256 hash used to determine cache key is created from Scarb.toml file. As soon as Scarb lock file will be implemented it should be used instead, as that's what other package managers such as npm or yarn are doing to cache reliably.

Depends on software-mansion/scarb#126

Problem

Better to avoid having the scarb version repeated across many places

Proposed Solution

Something like this:

      - name: Getting scarb
        uses: software-mansion/setup-scarb@v1
        with:
          scarb-version: from-tool-versions

/.tool-versions in the repo:

scarb 0.5.2

Notes

No response

Problem

https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20

Proposed Solution

Modify the action to run on Node 20 instead of Node 16. For guidance, refer to: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions

Notes

No response

Problem

We currently have this monster in our codebase. Let's use the newly added scarb cache path command to make it simpler.

Proposed Solution

See text in problem

Notes

Depends on software-mansion/scarb#558

Problem

One of our users has a Scarb project in a submodule/subdirectory of the repository. This project contains a .tool-versions file that the user wants to use as reference point for version selection, but there is no way to instruct the action to look for this file elsewhere than the working directory.

Proposed Solution

Add a new input, named tool-versions, typed as an optional string. It will accept a path, absolute or relative to action's PWD, to the tool-versions file, that must exist. If provided, the action will always and only look for Scarb version in that provided path. No other deduction techniques will be applied, and inability to look for information should yield an error.

Example:

- uses: software-mansion/setup-scarb@v1
  with:
    tool-versions: ./my-submodule/.tool-versions

Notes

Most of the meat lies in this file: https://github.com/software-mansion/setup-scarb/blob/67ef98b555967b95dd7fc56ecdd1e93ce7cefdae/lib/versions.js. It is called from here:

Problem

Actions are now failing with this warning:

Steps

No response

Possible Solution(s)

We miss declarations for this input in action.yml

Notes

Release 1.3.1 immediately after merging this.

Like setup-ruby does with .ruby-version

https://github.com/ruby/setup-ruby

TBD software-mansion/scarb#271

Allow the action to set up caching of Scarb cache out of the box. You'll need to use post-run hook in the action and call actions/cache library.
Links:

• https://docs.swmansion.com/scarb/docs/reference/global-directories#cache-directory
• https://github.com/actions/toolkit/tree/main/packages/cache