Metrics reports documentation is incomplete

This commit is contained in:
Matija Čupić 2019-06-12 02:56:22 +00:00 committed by Evan Read
parent c6152f3d28
commit abad9c5eeb
1 changed files with 5 additions and 0 deletions

View File

@ -28,6 +28,11 @@ Consider the following examples of data that can utilize Metrics Reports:
Metrics are read from the metrics report (default: `metrics.txt`). They are parsed and displayed in the MR widget.
All values are considered strings and string compare is used to find differences between the latest available `metrics` artifact from:
- `master`
- The feature branch
## How to set it up
Add a job that creates a [metrics report](yaml/README.md#artifactsreportsmetrics-premium) (default filename: `metrics.txt`). The file should conform to the [OpenMetrics](https://openmetrics.io/) format.