summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatija Čupić <matteeyah@gmail.com>2019-06-07 12:44:13 +0200
committerMatija Čupić <matteeyah@gmail.com>2019-06-11 13:07:31 +0200
commit3a85c564316662ff53fd2b6f75ed8bf683a34265 (patch)
treeae75bf31ed85933c925e244428fe60dd723be792
parent3ef0c54966ec79de0a713e089b62b46c79e8a663 (diff)
downloadgitlab-ce-mc/docs/metrics-reports-docs.tar.gz
Fill metrics reports docs with missing piecesmc/docs/metrics-reports-docs
-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..66d6d8c32fe 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.