https://github.com/kludex/benchmarco

WIP - A performance bot for GitHub hosted repositories! ⚡️
https://github.com/kludex/benchmarco

Last synced: 3 months ago
JSON representation

WIP - A performance bot for GitHub hosted repositories! ⚡️

• Host: GitHub
• URL: https://github.com/kludex/benchmarco
• Owner: Kludex
• Created: 2021-08-31T07:30:22.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-31T19:51:36.000Z (about 4 years ago)
• Last Synced: 2024-10-17T15:29:51.326Z (about 1 year ago)
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Benchmarco - The Benchmarking Bot

Benchmarco is a bot that runs benchmarks on your code and reports the results.

## Usage

Simple usage should be as follows:

```yml

name: Benchmark

on:

    pull_requests: [main]

jobs:

    benchmark:

        runs-on: ubuntu-latest

        steps:

        - uses: actions/benchmarco@v1

          with:

            script: run.sh

            compare: main

```

## Configuration

### `compare` - Compare with previous results

It can assume the following values:

* `main` - Compare with the main branch.

* `tag` - Compare with the latest tag.

### `script` - Script to run

This is the path to the script to run e.g. `run.sh` . The root path is the root of the repository.