summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatija Čupić <matteeyah@gmail.com>2019-06-12 02:56:22 +0000
committerEvan Read <eread@gitlab.com>2019-06-12 02:56:22 +0000
commitabad9c5eeb7be1b20033e435c35b177315baad19 (patch)
tree032be46d5fc048977a9183af5996000853178efe /doc
parentc6152f3d28fd609600eeea10fbd38202b33af2d9 (diff)
downloadgitlab-ce-abad9c5eeb7be1b20033e435c35b177315baad19.tar.gz
Metrics reports documentation is incomplete
Diffstat (limited to 'doc')
-rw-r--r--doc/ci/metrics_reports.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/ci/metrics_reports.md b/doc/ci/metrics_reports.md
index b7824402d45..3ded6673149 100644
--- a/doc/ci/metrics_reports.md
+++ b/doc/ci/metrics_reports.md
@@ -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.