@backstage-community/plugin-code-coverage 0.2.28

package/README.md

@@ -0,0 +1,51 @@
+# code-coverage
+
+This is the frontend part of the code-coverage plugin. It displays code coverage summaries for your entities.
+
+## Installation
+
+```sh
+# From your Backstage root directory
+yarn --cwd packages/app add @backstage-community/plugin-code-coverage
+```
+
+Finally you need to import and render the code coverage entity, in `packages/app/src/components/catalog/EntityPage.tsx` add the following:
+
+```diff
+@@ -70,6 +70,7 @@ import {
+
+ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
+ import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
++import { EntityCodeCoverageContent } from '@backstage-community/plugin-code-coverage';
+
+@@ -226,6 +227,10 @@ const defaultEntityPage = (
+     <EntityLayout.Route path="/docs" title="Docs">
+       {techdocsContent}
+     </EntityLayout.Route>
++
++    <EntityLayout.Route path="/code-coverage" title="Code Coverage">
++      <EntityCodeCoverageContent />
++    </EntityLayout.Route>
+   </EntityLayout>
+ );
+```
+
+## 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.
+
+```yaml
+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`.
+
+```yaml
+metadata:
+  annotations:
+    backstage.io/code-coverage: scm-only
+```
+
+Note: It may be required to set the [`backstage.io/source-location` annotation](https://backstage.io/docs/features/software-catalog/well-known-annotations#backstageiosource-location), however this should generally not be needed.

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="react" />
+import { Entity } from '@backstage/catalog-model';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+
+/**
+ * Returns true if the given entity has code coverage enabled.
+ *
+ * @public
+ */
+declare function isCodeCoverageAvailable(entity: Entity): boolean;
+
+/**
+ * @public
+ */
+declare const codeCoveragePlugin: _backstage_core_plugin_api.BackstagePlugin<{
+    root: _backstage_core_plugin_api.RouteRef<undefined>;
+}, {}, {}>;
+/**
+ * An entity code coverage page.
+ *
+ * @public
+ */
+declare const EntityCodeCoverageContent: () => JSX.Element;
+
+/**
+ * A Backstage plugin that helps you keep track of your code coverage
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * @public
+ * @deprecated Use `isPluginApplicableToEntity` instead.
+ */
+declare const isPluginApplicableToEntity: typeof isCodeCoverageAvailable;
+
+export { EntityCodeCoverageContent, codeCoveragePlugin, isCodeCoverageAvailable, isPluginApplicableToEntity };