@backstage-community/plugin-xcmetrics 0.2.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # XCMetrics
2
+
3
+ [XCMetrics](https://xcmetrics.io) is a tool for collecting build metrics from XCode.
4
+ With this plugin, you can view data from XCMetrics directly in Backstage.
5
+
6
+ ![XCMetrics-overview](./docs/XCMetrics-overview.png)
7
+
8
+ ## Getting started
9
+
10
+ ```bash
11
+ # From your Backstage root directory
12
+ yarn --cwd packages/app add @backstage-community/plugin-xcmetrics
13
+ ```
14
+
15
+ In `packages/app/src/App.tsx`, add the following:
16
+
17
+ ```ts
18
+ import { XcmetricsPage } from '@backstage-community/plugin-xcmetrics';
19
+ ```
20
+
21
+ ```tsx
22
+ <FlatRoutes>
23
+ {/* Other routes... */}
24
+ <Route path="/xcmetrics" element={<XcmetricsPage />} />
25
+ </FlatRoutes>
26
+ ```
27
+
28
+ Add the URL to your XCMetrics backend instance in `app-config.yaml` like so:
29
+
30
+ ```yaml
31
+ proxy:
32
+ ...
33
+ '/xcmetrics':
34
+ target: http://127.0.0.1:8080/v1
35
+ ```
36
+
37
+ Start Backstage and navigate to `/xcmetrics` to view your build metrics!