bitfancy/Generate gas diff
Easily compare gas reports generated by foundry!
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| token | The repository's github token. | no | ${{ github.token }} |
| base | The gas diff reference branch name. | no | ${{ github.base_ref || github.ref_name }} |
| head | The gas diff target branch name. | no | ${{ github.head_ref || github.ref_name }} |
| report | Report freshly generated to compare to reference. | no | gasreport.ansi |
| header | The top section displayed in the markdown output. | no | # Changes to gas cost |
| summaryQuantile | The quantile threshold to filter avg gas cost diffs to display in the summary top section. | no | 0.8 |
| sortCriteria | The list of criteria to order diff rows by in the report (name | min | avg | median | max | calls), separated by a comma. Must have the same length as sortOrders. | no | name |
| sortOrders | The list of directions to order diff rows in the report, according to order criteria (asc | desc), separated by a comma. Must have the same length as sortCriteria. | no | asc |
| ignore | The list of contract paths from which to ignore gas reports, separated by a comma. | no | — |
| match | The list of contract paths of which only to keep gas reports, separated by a comma. | no | — |
Outputs
| name | description |
|---|---|
| shell | The gas diff between the base gas report and the freshly generated gas report, specifically formatted for shell display |
| markdown | The gas diff between the base gas report and the freshly generated gas report, specifically formatted for markdown display |