README.md

Dart Benchmark Action

A GitHub Action to run benchmarks on Dart/Flutter projects and libraries.

In order to use it, add it as an Action to your GitHub repository:

name: Benchmark

on: [pull_request]

jobs:
  benchmark:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: dart-lang/setup-dart@v1
      - run: dart pub get

      - uses: luanpotter/dart-benchmark-action@v0.1.4
        with:
          paths: '<path-to-your-dart-project>,<more>'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

This is what the comment can look like:

But it will use tables and toggles depending on the amount of projects/packages you have and the number of performance tests associated with them.

Local Setup

To build, lint, and run tests locally, run:

  npm install
  npm run all