Commit abad9c5e authored by Matija Čupić's avatar Matija Čupić Committed by Evan Read

Metrics reports documentation is incomplete

parent c6152f3d
...@@ -28,6 +28,11 @@ Consider the following examples of data that can utilize Metrics Reports: ...@@ -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. 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 ## 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. 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.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment