diff --git a/README.md b/README.md index 8292751..f8fbdb8 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,13 @@ Sets up [Starknet Foundry] in your GitHub Actions workflow supporting caching out of the box. +> 📝 **Note** +> At this moment, only Linux and MacOS are supported. + ## Example workflow +Make sure you pass the valid path to `Scarb.lock` to [setup-scarb](https://github.com/marketplace/actions/setup-scarb) action. This way, all dependencies including snforge_scarb_plugin will be cached between runs. + ```yaml name: My workflow on: @@ -13,9 +18,18 @@ jobs: check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: foundry-rs/setup-snfoundry@v3 - - run: snforge + - uses: actions/checkout@v4 + + - name: Setup Starknet Foundry + uses: foundry-rs/setup-snfoundry@v3 + + - name: Setup Scarb + uses: software-mansion/setup-scarb@v1 + with: + scarb-lock: ./hello_starknet/Scarb.lock + + - name: Run tests + run: cd hello_starknet && snforge test ``` ## Inputs @@ -35,4 +49,6 @@ jobs: 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`). +For more information, visit [Starknet Foundry docs section](https://foundry-rs.github.io/starknet-foundry/appendix/starknet-foundry-github-action.html) dedicated to CI setup. + [Starknet Foundry]: https://foundry-rs.github.io/starknet-foundry