@backstage-community/plugin-cicd-statistics 0.12.0 → 0.12.1

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/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @backstage-community/plugin-cicd-statistics
2
2
 
3
+ ## 0.12.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 8202df6: Added documentation for the New Frontend System
8
+
3
9
  ## 0.12.0
4
10
 
5
11
  ### Minor Changes
package/README.md CHANGED
@@ -11,3 +11,27 @@ To use this plugin, you need to implement an API `CicdStatisticsApi` and bind it
11
11
  First time the UI shows, and each time the user changes filters and clicks `Update` to refresh the data, `fetchBuilds` is invoked with the filter options. The API implementation is the expected to fetch build information from somewhere, format it into a generic and rather simple type `Build` (also defined in `types.ts`). The API can optionally signal completion for a progress bar in the UI.
12
12
 
13
13
  When this plugin has fetched the builds, it will transpose the list of builds (and build stages) into a tree of build stages. As build pipelines sometimes change, certain stages might end or begin within the date range of the view (when _Normalize time range_ is enabled, which is the default).
14
+
15
+ ## New Frontend System
16
+
17
+ ### Setup
18
+
19
+ If you're using [feature discovery](https://backstage.io/docs/frontend-system/architecture/app/#feature-discovery), the plugin should be automatically discovered and enabled. Otherwise, you can manually enable the plugin by adding it to your app:
20
+
21
+ ```tsx
22
+ // packages/app/src/App.tsx
23
+ import cicdStatisticsPlugin from '@backstage-community/plugin-cicd-statistics/alpha';
24
+
25
+ const app = createApp({
26
+ features: [
27
+ // ...
28
+ cicdStatisticsPlugin,
29
+ ],
30
+ });
31
+ ```
32
+
33
+ ### Extensions
34
+
35
+ The following extensions are available in the plugin:
36
+
37
+ - `entity-content:cicd-statistics/entity`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-cicd-statistics",
3
- "version": "0.12.0",
3
+ "version": "0.12.1",
4
4
  "description": "A frontend plugin visualizing CI/CD pipeline statistics (build time)",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",