alde
e7d2fb93f0
In order to use this plugin, you must set the
`backstage.io/code-coverage` annotation on your entity.
```yaml
backstage.io/code-coverage: enabled
```
There's a feature to only include files that are in SCM 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
backstage.io/code-coverage: scm-only
```
The backend plugin provides API endpoints for submitting code-coverage
reports. Currently jacoco and cobertura are supported. These reports
are normalized to a json format that is stored in the database.
```json
// curl -X POST -H "Content-Type:text/xml" -d @cobertura.xml "localhost:7000/api/code-coverage/Component/default/entity-name?coverageType=cobertura"
{
"links": [
{
"href": "http://localhost:7000/api/code-coverage/Component/default/entity-name",
"rel": "coverage"
}
]
}
```
It also provides some additional API endpoints:
* Viewing the latest report
* Viewing a more condensed history of code coverage values
* Retrieving file contents from source-control, used by the UI
Provides a graph of code coverage change over time, as well as a file
view where you can see the highlighted lines.
Co-authored-by: nissayeva <natashaaay@gmail.com>
Signed-off-by: alde <r.dybeck@gmail.com>
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
51 lines
1.3 KiB
JSON
51 lines
1.3 KiB
JSON
{
|
|
"name": "@backstage/plugin-code-coverage-backend",
|
|
"version": "0.1.1",
|
|
"main": "src/index.ts",
|
|
"types": "src/index.ts",
|
|
"license": "Apache-2.0",
|
|
"publishConfig": {
|
|
"access": "public",
|
|
"main": "dist/index.cjs.js",
|
|
"types": "dist/index.d.ts"
|
|
},
|
|
"scripts": {
|
|
"start": "backstage-cli backend:dev",
|
|
"build": "backstage-cli backend:build",
|
|
"lint": "backstage-cli lint",
|
|
"test": "backstage-cli test",
|
|
"prepack": "backstage-cli prepack",
|
|
"postpack": "backstage-cli postpack",
|
|
"clean": "backstage-cli clean"
|
|
},
|
|
"dependencies": {
|
|
"@backstage/backend-common": "^0.5.4",
|
|
"@backstage/catalog-client": "^0.3.6",
|
|
"@backstage/catalog-model": "^0.7.2",
|
|
"@backstage/config": "^0.1.3",
|
|
"@backstage/errors": "^0.1.1",
|
|
"@backstage/integration": "^0.5.0",
|
|
"@backstage/plugin-catalog-backend": "^0.6.5",
|
|
"@types/express": "^4.17.6",
|
|
"cross-fetch": "^3.0.6",
|
|
"express": "^4.17.1",
|
|
"express-promise-router": "^3.0.3",
|
|
"express-xml-bodyparser": "^0.3.0",
|
|
"knex": "^0.95.1",
|
|
"uuid": "^8.3.2",
|
|
"winston": "^3.2.1",
|
|
"yn": "^4.0.0"
|
|
},
|
|
"devDependencies": {
|
|
"@backstage/cli": "^0.6.2",
|
|
"@types/express-xml-bodyparser": "^0.3.2",
|
|
"@types/supertest": "^2.0.8",
|
|
"msw": "^0.21.2",
|
|
"supertest": "^4.0.2",
|
|
"xml2js": "^0.4.23"
|
|
},
|
|
"files": [
|
|
"dist"
|
|
]
|
|
}
|