adding-benchmarks

Automate benchmark creation and CI integration across multi-package repositories.

449|615|Updated Feb 20, 2023

Search Tags:#benchmarking #dashboard #benchmarks #CI #benchmark-json #bootstrap.sh

Ready to run

npx skills add https://github.com/AztecProtocol/aztec-packages --skill adding-benchmarks

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: adding-benchmarks
Source: https://github.com/AztecProtocol/aztec-packages/tree/main/.claude/skills/adding-benchmarks
Command: npx skills add https://github.com/AztecProtocol/aztec-packages --skill adding-benchmarks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the process of adding and tracking performance benchmarks across a software project by guiding the creation of benchmark definitions, integrating them into the CI bootstrap workflow, and ensuring they are uploaded to a central dashboard.

Core Features & Use Cases

Benchmark creation: Provide a structured JSON format for package-level bench-outs that are merged and labeled with package paths.
CI integration: Automatically wires benchmarks into bootstrap.sh and the bench command so results are collected and uploaded to the dashboard.
Dashboard visibility: Ensures benchmarks appear in the monitoring dashboard with historical tracking for long-term trends.

Quick Start

Start by creating bench-out files for your packages (e.g., bench-out/mypackage.bench.json), then register them in bootstrap.sh's bench_cmds and run the tests to generate and upload results.

Frequently Asked Questions about adding-benchmarks

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automate CI performance benchmarks for a multi-package repository?▼

CI benchmark automation involves creating package-level bench-out JSON files, registering them in bootstrap.sh via bench_cmds, and configuring CI workflows to merge and upload results to a central dashboard for tracking.

What format do package benchmarks need to be in for CI dashboard tracking?▼

Package benchmarks must be emitted as bench-out/*.bench.json files. These benchmark JSON outputs are then merged, labeled with package path prefixes, and uploaded to the dashboard for historical performance tracking.

How do I register a new benchmark in bootstrap.sh?▼

You register a new benchmark in bootstrap.sh by adding it to the bench_cmds section. This wires the benchmark command into the CI workflow so generated results are collected and uploaded to the dashboard.

Does CI benchmark integration work for multiple packages in a single repository?▼

Yes, CI benchmark integration is designed for multi-package projects. It merges bench JSON files from individual packages, prefixes them with their package paths, and uploads the combined results to the dashboard.

Why are my benchmark results not showing up on the CI dashboard?▼

Benchmark results may not appear on the dashboard if packages are not emitting bench-out/*.bench.json files, if they are not registered in bootstrap.sh via bench_cmds, or if CI workflow uploads through ci3.yml are not configured.