Skip to content
activity

GitHub Action

Setup Scarb

v1.4.0 Latest version

Setup Scarb

activity

Setup Scarb

Sets up Scarb in your GitHub Actions workflow

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Setup Scarb

uses: software-mansion/setup-scarb@v1.4.0

Learn more about this action in software-mansion/setup-scarb

Choose a version

Install Scarb

Sets up Scarb in your GitHub Actions workflow supporting caching out of the box.

Example workflow

name: My workflow
on:
  push:
  pull_request:
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: software-mansion/setup-scarb@v1
        with:
          scarb-version: "2.3.0"
      - run: scarb fmt --check
      - run: scarb test

Inputs

  • scarb-version - Optional. String, either:
    • Stating an explicit Scarb version to use, for example "2.3.0".
    • Stating an explicit nightly tag to use, for example "nightly-2023-08-24".
    • "latest" to download latest stable version.
    • "nightly" to download latest nightly version.
    • Empty/not specified: the .tool-versions file will be read to resolve Scarb version, and in case it is not present the latest stable version will be used.
  • tool-versions - Optional. String.
    • Stating a relative or absolute path to the .tool-versions file.
    • Should be used only if scarb-version is not specified.
  • scarb-lock - Optional. String.
    • Stating a relative or absolute path to the Scarb.lock file used for caching dependencies.
    • Empty/not specified: Scarb.lock in the working directory will be used.

Outputs

  • scarb-prefix - A path to where Scarb has been extracted to. The scarb binary will be located in the bin subdirectory (${{ steps.setup-scarb.outputs.scarb-prefix }}/bin).
  • scarb-version - Installed Scarb version (as reported by scarb -V).