When to archive a benchmark

Archive benchmarks when the benchmarked code has been permanently removed from your codebase or when benchmarks are no longer relevant to your project. Archive benchmarks when:
  • The benchmarked code has been deleted or deprecated
  • Benchmarks are consistently skipped due to removed functionality
  • You want to clean up obsolete benchmarks from active reports
Do not archive benchmarks when:
  • The code still exists but benchmarks are flaky (ignore them instead)
  • Benchmarks are temporarily disabled but may be re-enabled
  • You’re unsure if the benchmark will be needed in the future
Unlike ignoring benchmarks, archival is for removed code. Archived benchmarks can be restored at any time, but they are completely removed from active reports.

Effects of archiving a benchmark

An archived benchmark will be completely removed from active reports. However, all historical data is preserved and the benchmark can be restored at any time. Archived benchmarks can be found in the Archived tab on the benchmarks page, and their individual dashboard pages remain accessible with full historical data. Archiving or restoring a benchmark will regenerate and potentially modify the reports of the latest commits of the default branch and branches with opened pull requests.

How to archive a benchmark

Archiving Permissions: When working with an organization’s repository, only the admins are allowed to archive or restore benchmarks.

From the skipped benchmarks section

The most common way to archive benchmarks is from the skipped section of a branch report:
  1. Navigate to a branch page that shows skipped benchmarks
  2. In the Skipped Benchmarks section, click the archive button next to benchmarks that are no longer needed
  3. Confirm the archival action in the modal

From a benchmark’s dashboard

You can also archive individual benchmarks from their dashboard:
  1. Navigate to the benchmark’s dashboard by clicking on its name in any report
  2. Click the Archive button on the benchmark’s dashboard
  3. Confirm the archival action

How to restore an archived benchmark

You can restore an archived benchmark at any time:
  1. Navigate to the archived benchmark’s dashboard (found in the Archived tab on the benchmarks page)
  2. Click the Restore button
  3. The benchmark will reappear in active reports