Perf/improvements #308
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Forge Test and Gas Difference | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - dev | |
| pull_request: | |
| paths: | |
| - contracts/** | |
| - test/** | |
| - foundry.toml | |
| - .github/workflows/PR-CI.yml | |
| jobs: | |
| check: | |
| name: Foundry project | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| cache: 'npm' | |
| - run: npm ci --ignore-scripts | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| with: | |
| version: nightly | |
| - name: Check Solhint | |
| run: npm run lint-contract | |
| - name: Check formatting | |
| run: npm run prettier-check | |
| # Generate a gas report to a temporary file named gasreport.ansi. | |
| - name: Run tests | |
| run: | | |
| set -o pipefail # Enable pipefail to capture first failure code | |
| forge test --gas-report | tee gasreport.ansi | |
| env: | |
| # make fuzzing semi-deterministic to avoid noisy gas cost estimation | |
| # due to non-deterministic fuzzing (but still use pseudo-random fuzzing seeds) | |
| FOUNDRY_PROFILE: ci | |
| FOUNDRY_FUZZ_SEED: 0x${{ github.event.pull_request.base.sha || github.sha }} | |
| TEST_MNEMONIC: ${{ secrets.TEST_MNEMONIC }} | |
| ARB_URL: ${{ secrets.ARB_URL }} | |
| FORK_BLOCK: ${{secrets.FORK_BLOCK}} | |
| - name: Compare gas reports | |
| uses: Rubilmax/foundry-gas-diff@v3.16 | |
| with: | |
| summaryQuantile: 0.9 # only display the 10% most significant gas diffs in the summary (defaults to 20%) | |
| sortCriteria: avg,max # sort diff rows by criteria | |
| sortOrders: desc,asc # and directions | |
| ignore: test-foundry/**/* # filter out gas reports from specific paths (test/ is included by default) | |
| id: gas_diff | |
| - name: Add gas diff to sticky comment | |
| if: github.event_name == 'pull_request' || github.event_name == 'pull_request_target' | |
| uses: marocchino/sticky-pull-request-comment@v2 | |
| with: | |
| # delete the comment in case changes no longer impact gas costs | |
| delete: ${{ !steps.gas_diff.outputs.markdown }} | |
| message: ${{ steps.gas_diff.outputs.markdown }} |