From 57a10500cd9d471d41a1bbaeb6094f3ffe7148cd Mon Sep 17 00:00:00 2001 From: alde Date: Mon, 19 Apr 2021 13:06:01 -0400 Subject: [PATCH] add code-coverage annotation to well-known-annotations MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .../software-catalog/well-known-annotations.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/features/software-catalog/well-known-annotations.md b/docs/features/software-catalog/well-known-annotations.md index 0053c14b79..5cfe8f39ef 100644 --- a/docs/features/software-catalog/well-known-annotations.md +++ b/docs/features/software-catalog/well-known-annotations.md @@ -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