Files

T

Patrik Oldsberg 820de63018 Merge pull request #6076 from backstage/rugvip/allreports

scripts/api-extractor: create and check API reports for all(most) plugins

2021-06-17 15:46:11 +02:00

dev

…

src

final fixup

2021-04-21 13:30:21 +02:00

.eslintrc.js

…

api-report.md

plugins: generate api reports

2021-06-17 13:30:06 +02:00

CHANGELOG.md

Version Packages

2021-05-27 10:23:15 +00:00

package.json

Version Packages

2021-06-17 08:08:44 +00:00

README.md

final fixup

2021-04-21 13:30:21 +02:00

README.md

code-coverage

This is the frontend part of the code-coverage plugin. It displays code coverage summaries for your entities.

Configuring your entity

In order to use this plugin, you must set the backstage.io/code-coverage annotation on entities for which coverage ingestion has been enabled.

metadata:
  annotations:
    backstage.io/code-coverage: enabled

There's a feature to only include files that are in VCS in the coverage report, this is helpful to not count generated files for example. To enable this set the backstage.io/code-coverage annotation to scm-only.

metadata:
  annotations:
    backstage.io/code-coverage: scm-only

Note: It may be required to set the backstage.io/source-location annotation, however this should generally not be needed.