feat: add changeset and update readme

Signed-off-by: Anton Ganhammar <ganhammar@gmail.com>
2023-08-20 21:36:59 +02:00
parent 499e76c934
commit 3f1367b956
2 changed files with 23 additions and 0 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-code-coverage-backend': patch
+---
+
+Added support for LCOV coverage reports
@@ -125,6 +125,24 @@ Example:
 }
 ```

+### Adding a LCOV report
+
+POST a LCOV INFO file to `/report`
+
+Example:
+
+```json
+// curl -X POST -H "Content-Type:text/plain" -d @coverage.info "localhost:7007/api/code-coverage/report?entity=component:default/entity-name&coverageType=lcov"
+{
+  "links": [
+    {
+      "href": "http://localhost:7007/api/code-coverage/report?entity=component:default/entity-name",
+      "rel": "coverage"
+    }
+  ]
+}
+```
+
 ### Reading json coverage

 GET `/report`