https://github.com/foundry-rs/setup-snfoundry
A github action for setting up snfoundry
https://github.com/foundry-rs/setup-snfoundry
Last synced: about 2 months ago
JSON representation
A github action for setting up snfoundry
- Host: GitHub
- URL: https://github.com/foundry-rs/setup-snfoundry
- Owner: foundry-rs
- License: mit
- Created: 2023-08-21T09:27:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T08:51:30.000Z (5 months ago)
- Last Synced: 2025-04-06T02:12:16.417Z (3 months ago)
- Language: JavaScript
- Size: 657 KB
- Stars: 12
- Watchers: 7
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Install Starknet Foundry
Sets up [Starknet Foundry] in your GitHub Actions workflow supporting caching out of the box.
## Example workflow
```yaml
name: My workflow
on:
push:
pull_request:
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: foundry-rs/setup-snfoundry@v4
- 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 `snforge`and `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`).
[Starknet Foundry]: https://foundry-rs.github.io/starknet-foundry