sisl-uic/CodSpeed Performance Analysis
Continuous benchmarking and performance checks
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| run | The command to run the benchmarks | no | — |
| mode | The mode(s) to run the benchmarks in. Accepts a single value or a comma-separated list (e.g., "simulation,walltime"). The following modes are available: - `simulation`: Run the benchmarks with CPU simulation measurements. - `walltime`: Run the benchmarks with walltime measurement. - `memory`: Run the benchmarks with allocation measurements. - `instrumentation`: (Deprecated) Legacy name for `simulation`. Please use `simulation` instead. We strongly recommend starting with the `simulation` mode. Using the `walltime` mode on traditional VMs/Hosted Runners might lead to inconsistent data. For the best results, we recommend using CodSpeed Hosted Macro Runners, which are fine-tuned for performance measurement consistency. Check out the [Walltime Instrument Documentation](https://docs.codspeed.io/instruments/walltime/) for more details. | yes | — |
| token | CodSpeed upload token. Only required for private repositories. | no | — |
| working-directory | The directory where the `run` command will be executed. Warning: if you use defaults.working-directory, you must still set this parameter. | no | — |
| upload-url | The upload endpoint (for on-premise deployments) | no | — |
| runner-version | The version of the runner to use. Use 'latest' to automatically fetch the latest release version from GitHub, or specify a version like '3.5.0' or 'v3.5.0'. | no | — |
| instruments | Comma separated list of instruments to enable. The following instruments are available: - `mongodb`: MongoDB instrumentation, requires the MongoDB instrument to be enabled for the organization in CodSpeed | no | — |
| mongo-uri-env-name | The name of the environment variable containing the MongoDB URI. Requires the `mongodb` instrument to be activated in `instruments`. If the instrumentation is enabled and this value is not set, the user will need to dynamically provide the MongoDB URI to the CodSpeed runner. | no | — |
| cache-instruments | Enable caching of instrument installations (like valgrind or perf) to speed up subsequent workflow runs. Set to 'false' to disable caching. | no | true |
| instruments-cache-dir | The directory to use for caching installations of instruments (like valgrind or perf). Defaults to `$HOME/.cache/codspeed-action`. | no | ~/.cache/codspeed-action |
| allow-empty | Allow the action to complete successfully even if no benchmarks were found or run. Set to 'true' to enable this behavior. | no | false |
| go-runner-version | The version of the go-runner to use (e.g., 1.0.0, 1.0.0-beta.1). If not specified, the latest version will be installed | no | — |
| config | Path to a CodSpeed configuration file (codspeed.yml). If not specified, the runner will look for a codspeed.yml file in the repository root. | no | — |
| skip-hash-check-warning | Suppress the warning emitted when hash verification is not available (e.g. when using 'latest', branch, or revision versions). | no | false |
Outputs
no outputs