asterinas/Continuous Benchmark
Continuous Benchmark using GitHub pages as dash board for keeping performance
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| output-file-path | A path, glob pattern, or regular expression matching JSON file(s) which contain the benchmark output and metadata. | yes | — |
| gh-pages-branch | Branch for gh-pages. | yes | gh-pages |
| gh-repository | Optional different repository URL to store benchmark results (e.g., github.com/owner/results-repo). | no | — |
| benchmark-data-dir-path | Path to directory for benchmark files on the GitHub Pages branch. | yes | dev/bench |
| github-token | GitHub API token for operations like pushing to gh-pages or commenting. Use secrets.GITHUB_TOKEN or a PAT. | no | — |
| ref | Optional Git ref (branch, tag, commit SHA) to associate the benchmark results with. | no | — |
| auto-push | Automatically push changes to the GitHub Pages branch. Requires github-token. | no | false |
| skip-fetch-gh-pages | Skip pulling the GitHub Pages branch before committing updates. | no | false |
| comment-always | Always post a comment comparing current benchmark results with previous. Requires github-token. | no | false |
| summary-always | Always generate a job summary with benchmark results. | no | false |
| save-data-file | Save benchmark data to the external file specified by external-data-json-path instead of gh-pages. | no | true |
| comment-on-alert | Post a comment when a benchmark result exceeds the alert threshold (from JSON metadata or fail-threshold). Requires github-token. | no | false |
| fail-on-alert | Fail the workflow step if any benchmark result exceeds the failure threshold (from JSON metadata or fail-threshold). | no | false |
| fail-threshold | Default failure threshold (e.g., "150%") if not specified in JSON metadata. Used for fail-on-alert. | no | — |
| alert-comment-cc-users | Comma-separated list of GitHub usernames to CC on alert comments (e.g., "@user1,@user2"). | no | — |
| external-data-json-path | Path to an external JSON file for storing benchmark data (alternative to gh-pages). Often used with actions/cache. | no | — |
| max-items-in-chart | Maximum number of data points to show per benchmark in charts. Older entries are removed. | no | — |
| summary-json-path | Optional path to a separate summary JSON file (distinct from output-file-path). | no | — |
Outputs
no outputs