README.nuget.org.md

Tool to analyze and compare .NET benchmark reports

PowerUtils.BenchmarkDotnet.Reporter is a command-line tool used to analyze and compare .NET benchmark reports generated by BenchmarkDotNet. This tool is designed to run locally or in CI/CD pipelines, providing a simple way to visualize and compare benchmark results.

Documentation

• 📖 Complete Documentation - Comprehensive guide on installation, usage, commands, and options
• ⚙️ GitHub Actions Setup Guide - Step-by-step guide to integrate the tool in your CI/CD pipeline

Quick Start

Install the Tool

dotnet tool install --global PowerUtils.BenchmarkDotnet.Reporter

Basic Usage

pbreporter compare -b baseline-full.json -t target-full.json -f markdown

CI/CD Integration

Integrate this tool into your GitHub Actions workflow to automatically compare benchmark results on pull requests:

- name: Compare Benchmark Results
  run: |
    pbreporter compare \
      -b baseline-report.json \
      -t current-report.json \
      -f markdown

For complete CI/CD setup instructions, see the GitHub Actions Setup Guide.

Contribution

If you have any questions, comments, or suggestions, please open an issue or create a pull request