Skip to content
activity

GitHub Action

Setup Starknet Foundry

v3.0.0 Latest version

Setup Starknet Foundry

activity

Setup Starknet Foundry

Sets up Starknet Foundry in your GitHub Actions workflow

Installation

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

              

- name: Setup Starknet Foundry

uses: foundry-rs/setup-snfoundry@v3.0.0

Learn more about this action in foundry-rs/setup-snfoundry

Choose a version

Install Starknet Foundry

Sets up Starknet Foundry 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: foundry-rs/setup-snfoundry@v2
      - run: snforge

Inputs

  • starknet-foundry-version - Optional. String:

    • Stating an explicit Starknet Foundry version to use, for example "0.9.1".
    • Empty/not specified: the .tool-versions file will be read to resolve starknet foundry 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 starknet-foundry-version is not specified.

Outputs

  • starknet-foundry-prefix - A path to where Starknet Foundry has been extracted to. The snforgeand sncast binaries will be located in the bin subdirectory (${{ steps.setup-starknet-foundry.outputs.starknet-foundry-prefix }}/bin).
  • starknet-foundry-version - Version of Starknet Foundry that was installed (as reported by snforge -V).