Benchmarker

Benchmarker is a benchmark runner based on Github Issues. Just create a new issue with the test case code blocks and Benchmarker Github Action workflow will execute the benchmark tests and post the results as a comment of the issue. See how it looks!

It supports Javascript and Node.js.

How it works

Open an issue, use the "Benchmark" template
Set the name of the benchmark test
Copy the test case codes and setup, teardown codes.
Save the issue and wait a few seconds. The Github Action will post the result as a comment.
If you want to modify the test, just edit the issue and save. The Github Action will rerun the test and update the comment.

Issue formats

Open #3 to see how the benchmark test looks.

Name of the benchmark test

Use h1 header for the name of benchmark test

# UUID versions

Dependencies

If your test needs NPM libraries, use the dependencies block and list all libraries. You can use just the name of library for latest version (uuid) or specify the version (uuid@11.0.4).

## Dependencies
- uuid@11.0.4

Setup

Use h2 header with Setup or Set up text and add a code block with the setup code.

    ## Setup

    ```js
    const uuid = require("uuid");

    const NS = uuid.v4();
    ```

Test case

Use h2 header with the name of the test case and add a code block with the test case code.

    ## Generate UUID v4

    ```js
    return uuid.v4();
    ```

Tear down

Use h2 header with Teardown or Tear down text and add a code block with the tear down code.

    ## Teardown

    ```js
    // Close DB connection
    db.close();
    ```

icebob/benchmarker