add code-coverage annotation to well-known-annotations

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-19 13:06:01 -04:00
parent 10f5e0c7ec
commit 57a10500cd
1 changed files with 14 additions and 0 deletions
@@ -273,6 +273,20 @@ project within your organization.
 Specifying this annotation may enable SonarQube related features in Backstage
 for that entity.

+### backstage.io/code-coverage
+
+```yaml
+# Example:
+metadata:
+  annotations:
+    backstage.io/code-coverage: scm-only
+```
+
+The value of this annotation controls the code-coverage backstage plugin. If set
+to smc-only the plugin will only take into account files stored in source
+control (e.g. ignoring generated code). If set to any other non-false:y value
+all files covered by a coverage report will be taken into account.
+
 ## Deprecated Annotations

 The following annotations are deprecated, and only listed here to aid in