GitHub Action
foundry-toolchain
This GitHub Action installs Foundry, the blazing fast, portable and modular toolkit for Ethereum application development.
on: [push]
name: test
jobs:
check:
name: Foundry project
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
- name: Run tests
run: forge test -vvv
- name: Run snapshot
run: forge snapshot
Name | Required | Default | Description | Type |
---|---|---|---|---|
version |
No | nightly |
Version to install, e.g. nightly or 1.0.0 . Note: Foundry only has nightly builds for the time being. |
string |
This action matches Forge's behavior and caches all RPC responses in the ~/.foundry/cache/rpc
directory. This is done to
speed up the tests and avoid hitting the rate limit of your RPC provider.
The logic of the caching is as follows:
- Always load the latest valid cache, and always create a new one with the updated cache.
- When there are no changes to the fork tests, the cache does not change but the key does, since the key is based on the commit hash.
- When the fork tests are changed, both the cache and the key are updated.
Note that if you are fuzzing in your fork tests, the RPC cache strategy above will not work unless you set a fuzz seed. You might also want to reduce your number of RPC calls by using Multicall.
You can add the output of Forge and Cast commands to GitHub step summaries. The summaries support GitHub flavored Markdown.
For example, to add the output of forge snapshot
to a summary, you would change the snapshot step to:
- name: Run snapshot
run: NO_COLOR=1 forge snapshot >> $GITHUB_STEP_SUMMARY
See the official GitHub docs for more information.