yoavniran/Overweight-Guard
Extensible bundle size guard with pluggable testers.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| config | Path to an overweight configuration file. | no | — |
| files | JSON string that overrides the configuration files array. | no | — |
| working-directory | Directory to run the checks from. | no | — |
| github-token | Token used to comment on pull requests. | no | — |
| comment-on-pr | Comment on pull requests when checks fail. | no | true |
| comment-on-pr-always | Also comment on the first PR run even when all checks pass. | no | false |
| comment-on-pr-each-run | Comment on every PR run regardless of the result. | no | false |
| baseline-report-path | Optional path to a JSON file with baseline results. Defaults to `report-file` when omitted and `update-baseline` is true. | no | — |
| update-baseline | When true, commit the updated baseline to a new branch and open a pull request. | no | false |
| baseline-protected-branches | Comma-separated list of branch names or glob patterns where baseline updates are forbidden (default: main,master). | no | main,master |
| baseline-threshold | Size tolerance below which a file is not treated as changed. A bare fraction between 0 and 1 (e.g. 0.01) is a percentage of the previous size; anything else is absolute bytes (e.g. 50, "50 B", "1 kB"). Set 0 to disable. | no | 0.01 |
| update-pr-title | Title of the pull request created when update-baseline is true. | no | chore: update baseline report |
| update-pr-body | Body of the pull request created when update-baseline is true. | no | Automatic pull request updating the overweight baseline report. |
| update-branch-prefix | Prefix for the temporary branch that carries the baseline update. | no | overweight/baseline |
| report-file | File path where the json report will be written. | no | overweight-report.json |
Outputs
| name | description |
|---|---|
| report-json | Serialized JSON report describing every bundle check. |
| report-table | HTML table that can be posted as a PR comment. |
| has-failures | true if any check failed. |
| baseline-updated | true if the baseline report file was updated. |
| report-file | Absolute path to the generated json report. |
| baseline-update-pr-url | URL of the pull request created for the baseline update. |
| baseline-update-pr-number | Number of the pull request created for the baseline update. |