CodSpeed Action

GitHub Actions for running CodSpeed in your CI.

Usage

- uses: CodSpeedHQ/action@v5with:
# [OPTIONAL]# The command used to run your CodSpeed benchmarks## Leave empty to use targets defined in your project configuration (e.g `codspeed.yml`)# https://codspeed.io/docs/cli#configuration# ⚠️ WARNING: for action/runner versions lower than v4.9.0, this parameter is required.run: "<YOUR_COMMAND>"# [REQUIRED]# The measurement mode(s) to use. Possible values: "simulation" (recommended), "walltime".# Accepts a single value or a comma-separated list (e.g., "simulation,walltime").# More details on the instruments at https://docs.codspeed.io/instruments/mode: "simulation"# [OPTIONAL]# CodSpeed recommends using OpenID Connect (OIDC) for authentication.## If you are not using OpenID Connect, set the CodSpeed upload token# that can be found at https://codspeed.io/<org>/<repo>/settings# It's strongly recommended to use a secret for this value# If you're instrumenting a public repository, you can omit this value altogether## More information in the CodSpeed documentation:# https://codspeed.io/docs/integrations/ci/github-actions#authenticationtoken: ""# [OPTIONAL]# The directory where the `run` command will be executed.# ⚠️ WARNING: if you use `defaults.run.working-directory`, you must still set this parameter.working-directory: ""# [OPTIONAL]# Path to a CodSpeed configuration file (codspeed.yml).# If not specified, the runner will look for a codspeed.yml file in the repository root.config: ""# [OPTIONAL]# Comma-separated list of instruments to enable. Possible values: mongodb.instruments: ""# [OPTIONAL]# The name of the environment variable that contains the MongoDB URI to patch.# If not provided, user will have to provide it dynamically through a CodSpeed integration.# Only used if the `mongodb` instrument is enabled.mongo_uri_env_name: ""# [OPTIONAL]# Enable caching of instrument installations (like valgrind or perf) to speed up# subsequent workflow runs. Set to 'false' to disable caching. Defaults to 'true'.cache-instruments: "true"# [OPTIONAL]# The directory to use for caching installations of instruments (like valgrind or perf).# This will speed up subsequent workflow runs by reusing previously installed instruments.# Defaults to $HOME/.cache/codspeed-action if not specified.instruments-cache-dir: ""# [OPTIONAL]# A custom upload url, only if you are using an on premise CodSpeed instanceupload-url: ""# [OPTIONAL]# 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 installedgo-runner-version: ""# [OPTIONAL]# Improve `simulation` accuracy by weighting each instruction by its estimated cycle# cost instead of charging every instruction the same fixed cost.# Set to "false" to disable. Requires runner v5 or later.# Defaults to "true".cycle-estimation: ""# [OPTIONAL]# Exclude memory allocation time from `simulation` mode results. Set to "true" to# enable. Requires runner v5 or later.# Defaults to "false".exclude-allocations: ""

Example usage

Python with pytest and pytest-codspeed

This workflow will run the benchmarks found in the tests/ folder and upload the results to CodSpeed.

It will be triggered on every push to the main branch and on every pull request.

name: CodSpeedon:
push:
branches:
- "main"# or "master"pull_request: # required to have reports on PRs# `workflow_dispatch` allows CodSpeed to trigger backtest# performance analysis in order to generate initial data.workflow_dispatch:
jobs:
benchmarks:
name: Run benchmarksruns-on: ubuntu-latestpermissions: # optional for public repositoriescontents: readid-token: write # for OpenID Connect authentication with CodSpeedsteps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v3with:
python-version: "3.9"
- name: Install dependenciesrun: pip install -r requirements.txt
- name: Run benchmarksuses: CodSpeedHQ/action@v5with:
mode: simulationrun: pytest tests/ --codspeed

Rust with cargo-codspeed and codspeed-criterion-compat / codspeed-bencher-compat

This workflow will run the benchmarks found in the tests/ folder and upload the results to CodSpeed.

It will be triggered on every push to the main branch and on every pull request.

name: CodSpeedon:
push:
branches:
- "main"# or "master"pull_request: # required to have reports on PRs# `workflow_dispatch` allows CodSpeed to trigger backtest# performance analysis in order to generate initial data.workflow_dispatch:
jobs:
name: Run benchmarksbenchmarks:
runs-on: ubuntu-latestpermissions: # optional for public repositoriescontents: readid-token: write # for OpenID Connect authentication with CodSpeedsteps:
- uses: actions/checkout@v4
- name: Setup rust toolchain, cache and cargo-codspeed binaryuses: moonrepo/setup-rust@v0with:
channel: stablecache-target: releasebins: cargo-codspeed
- name: Build the benchmark target(s)run: cargo codspeed build
- name: Run the benchmarksuses: CodSpeedHQ/action@v5with:
mode: simulationrun: cargo codspeed run

Node.js with codspeed-node, TypeScript and vitest

This workflow will run the benchmarks defined with vitest's bench function and upload the results to CodSpeed.

It will be triggered on every push to the main branch and on every pull request.

name: CodSpeedon:
push:
branches:
- "main"# or "master"pull_request: # required to have reports on PRs# `workflow_dispatch` allows CodSpeed to trigger backtest# performance analysis in order to generate initial data.workflow_dispatch:
jobs:
benchmarks:
name: Run benchmarksruns-on: ubuntu-latestpermissions: # optional for public repositoriescontents: readid-token: write # for OpenID Connect authentication with CodSpeedsteps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
- name: Install dependenciesrun: npm install
- name: Run benchmarksuses: CodSpeedHQ/action@v5with:
mode: simulationrun: npx vitest bench