Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
Update README.md.
  • Loading branch information
Joona Oikarinen committed Sep 30, 2021
1 parent 6a11cc1 commit 4d76fd8
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,46 @@ Github actions plugin to check flakiness of tests by calculating fliprates. Usag

## Features

* Prints out top test names and their latest calculation window scores (normal fliprate and exponentially weighted moving average fliprate that take previous calculation windows into account)
* Prints out top test names and their latest calculation window scores (normal fliprate and exponentially weighted moving average fliprate that take previous calculation windows into account).
* Calculation grouping options:
* `n` days
* `n` runs
* Heatmap visualization of the scores and history
* `n` days.
* `n` runs.
* Heatmap visualization of the scores and history.

## Parameters

### Data options (choose one)

* `--test-history-csv`
* Give a path to a test history csv file which includes three fields: `timestamp`, `test_identifier` and `test_status`
* Give a path to a test history csv file which includes three fields: `timestamp`, `test_identifier` and `test_status`.
* `--junit-files`
* Give a path to a folder with `JUnit` test results
* Give a path to a folder with `JUnit` test results.

### Calculation options

* `--grouping-option`
* `days` to use `n` days for fliprate calculation windows
* `runs` to use `n` runs for fliprate calculation windows
* `days` to use `n` days for fliprate calculation windows.
* `runs` to use `n` runs for fliprate calculation windows.

* `--window-size`
* Fliprate calculation window size `n`
* Fliprate calculation window size `n`.

* `--window-count`
* History size for exponentially weighted moving average calculations
* History size for exponentially weighted moving average calculations.

* `--top-n`
* How many top highest scoring tests to print out
* How many top highest scoring tests to print out.
### Heatmap generation
* `--heatmap`
* Turn heatmap generation on
* Two pictures generated: normal fliprate and exponentially weighted moving average fliprate score
* Same parameters used as with the printed statistics
* Turn heatmap generation on.
* Two pictures generated: normal fliprate and exponentially weighted moving average fliprate score.
* Same parameters used as with the printed statistics.

### Full examples

* Precomputed `test_history.csv` with daily calulations. 1 day windows, 7 day history and 5 tests printed out
* Precomputed `test_history.csv` with daily calulations. 1 day windows, 7 day history and 5 tests printed out.
* `--test-history-csv=example_history/test_history.csv --grouping-option=days --window-size=1 --window-count=7 --top-n=5`
* `JUnit` files with calculations per 5 runs. 15 runs history and 5 tests printed out
* `JUnit` files with calculations per 5 runs. 15 runs history and 5 tests printed out.
* `--junit-files=example_history/junit_files --grouping-option=runs --window-size=5 --window-count=3 --top-n=5`
* Precomputed `test_history.csv` with daily calculations and heatmap generation. 1 day windows, 7 day history and 50 tests printed and generated to heatmaps.
* `--test-history-csv=example_history/test_history.csv --grouping-option=days --window-size=1 --window-count=7 --top-n=50 --heatmap`
Expand Down

0 comments on commit 4d76fd8

Please sign in to comment.