paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 49 Packages Projects Releases Wiki Activity

Deprecate packages

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:45:44 +02:00
parent d6aaf01c1f
commit da543b3c70
5 changed files with 34 additions and 325 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/code-coverage/README.md
+2 -50
View File
@@ -1,51 +1,3 @@
# code-coverage
# Deprecated
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/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/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.
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-code-coverage` instead.
plugins/code-coverage/package.json
+20 -18
View File
@@ -1,33 +1,37 @@
{
"name": "@backstage/plugin-code-coverage",
"description": "A Backstage plugin that helps you keep track of your code coverage",
"version": "0.2.27",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
"description": "A Backstage plugin that helps you keep track of your code coverage",
"backstage": {
"role": "frontend-plugin",
"moved": "@backstage-community/plugin-code-coverage"
},
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
"backstage": {
"role": "frontend-plugin"
},
"homepage": "https://backstage.io",
"repository": {
"type": "git",
"url": "https://github.com/backstage/backstage",
"directory": "plugins/code-coverage"
},
"license": "Apache-2.0",
"sideEffects": false,
"main": "src/index.ts",
"types": "src/index.ts",
"files": [
"dist"
],
"scripts": {
"build": "backstage-cli package build",
"start": "backstage-cli package start",
"clean": "backstage-cli package clean",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
"postpack": "backstage-cli package postpack",
"clean": "backstage-cli package clean"
"start": "backstage-cli package start",
"test": "backstage-cli package test"
},
"dependencies": {
"@backstage/catalog-model": "workspace:^",
@@ -44,11 +48,6 @@
"react-use": "^17.2.4",
"recharts": "^2.5.0"
},
"peerDependencies": {
"react": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
},
"devDependencies": {
"@backstage/cli": "workspace:^",
"@backstage/dev-utils": "workspace:^",
@@ -59,7 +58,10 @@
"@types/react": "^16.13.1 || ^17.0.0 || ^18.0.0",
"@types/recharts": "^1.8.15"
},
"files": [
"dist"
]
"peerDependencies": {
"react": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
},
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-code-coverage instead."
}