chore(badges): Enhance warning in readme and describe how to allow configuration reading from frontend. Move remaining tests files beside the tested code

Signed-off-by: Rbillon59 <r.billon@celonis.com>
2023-04-28 18:38:07 +02:00
parent 00979497ac
commit 29078a6c05
5 changed files with 19 additions and 4 deletions
@@ -34,7 +34,9 @@ Please note that if you have already set badges in your repositories and you act

 Please note that the backend part needs to be configured to support obfuscation. See the [backend plugin documentation](../badges-backend/README.md) for more details.

-Also, you need to allow your frontend to access the configuration :
+Also, you need to allow your frontend to access the configuration see <https://backstage.io/docs/conf/defining/#visibility> :
+
+Example implementation would be in : `packages/app/src/config.d.ts`

 ```typescript
 export interface Config {
@@ -51,6 +53,16 @@ export interface Config {
 }
 ```

+then include in the `packages/app/package.json` :
+
+```json
+"files": [
+    "dist",
+    "config.d.ts"
+  ],
+"configSchema": "config.d.ts",
+```
+
 ## Sample Badges

 Here are some samples of badges for the `artists-lookup` service in the Demo Backstage site: