ymw0407/cargo-chronoscope
Record and diff Cargo build performance. Caches a baseline DB per branch and posts a sticky PR comment with the diff.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | cargo-chronoscope version to install. Pinning a concrete version (e.g. `0.1.9`) gives reproducible runs; `latest` always pulls the newest published crate. Defaults to the current recommended action version. | no | 0.1.9 |
| cargo-args | Arguments forwarded verbatim to `cargo build` via `cargo-chronoscope record -- <args>`. Default: `--release`. | no | --release |
| baseline-ref | Branch whose chronoscope DB is the baseline. Only pushes to this ref are allowed to update the cached DB. | no | main |
| cache-key-prefix | Prefix for the GitHub Actions cache key holding the DB. | no | chronoscope-db |
| comment | Post (or update) a sticky PR comment with the diff from inside this action's job. `true` or `false`. Works for same-repo PRs but silently fails on forked-PR runs because GitHub gives those runs a read-only token. To support fork PRs, set this to `false` and use `upload-artifact: true` together with the perf-comment.yml companion workflow — see examples/ci/. | no | true |
| upload-artifact | Upload perf-report.md and the PR number as a GitHub Actions artifact (named `perf-report`) so a workflow_run-triggered companion workflow can post the sticky comment from base-repo context. Use this for repos that accept fork PRs. Reference companion at examples/ci/perf-comment.yml. | no | false |
| github-token | Token used to post PR comments. Defaults to the workflow's automatic GITHUB_TOKEN. Only used when `comment` is `true` and the event is a pull_request. | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| build-id | The build ID assigned to this run by chronoscope. |
| report-path | Path (relative to the workspace) of the rendered Markdown report. |