@backstage/plugin-catalog 1.28.0-next.2 → 1.28.0

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.
Files changed (2) hide show
  1. package/CHANGELOG.md +118 -0
  2. package/package.json +22 -22
package/CHANGELOG.md CHANGED
@@ -1,5 +1,123 @@
1
1
  # @backstage/plugin-catalog
2
2
 
3
+ ## 1.28.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 247a40b: Now a custom entity page header can be passed as input to the default entity page.
8
+ - a3d93ca: The default layout of the entity page can now optionally be customized with 3 card types: info, peek and full.
9
+
10
+ - Cards of type `info` are rendered in a fixed area on the right;
11
+ - Cards of type `peek` are rendered on top of the main content area;
12
+ - Cards of type `full` and cards with undefined type are rendered as they were before, in the main content area, below the peek cards.
13
+
14
+ If you want to keep the layout as it was before, you don't need to do anything. But if you want to experiment with the card types and see how they render, here is an example setting the about card to be rendered as an `info` card:
15
+
16
+ ```diff
17
+ app:
18
+ extensions:
19
+ # Entity page cards
20
+ + - entity-card:catalog/about:
21
+ + config:
22
+ + type: info # or peek or full
23
+ ```
24
+
25
+ - 93533bd: The order in which group tabs appear on the entity page has been changed.
26
+
27
+ ### Before
28
+
29
+ Previously, entity contents determined the order in which groups were rendered, so a group was rendered as soon as its first entity content was detected.
30
+
31
+ ### After
32
+
33
+ Groups are now rendered first by default based on their order in the `app-config.yaml` file:
34
+
35
+ ```diff
36
+ app:
37
+ extensions:
38
+ - page:catalog/entity:
39
+ + config:
40
+ + groups:
41
+ + # this will be the first tab of the default entity page
42
+ + - deployment:
43
+ + title: Deployment
44
+ + # this will be the second tab of the default entiy page
45
+ + - documentation:
46
+ + title: Documentation
47
+ ```
48
+
49
+ If you wish to place a normal tab before a group, you must add the tab to a group and place the group in the order you wish it to appear on the entity page (groups that contains only one tab are rendered as normal tabs).
50
+
51
+ ```diff
52
+ app:
53
+ extensions:
54
+ - page:catalog/entity:
55
+ config:
56
+ groups:
57
+ + # Example placing the overview tab first
58
+ + - overview:
59
+ + title: Overview
60
+ - deployment:
61
+ title: Deployment
62
+ # this will be the second tab of the default entiy page
63
+ - documentation:
64
+ title: Documentation
65
+ - entity-content:catalog/overview:
66
+ + config:
67
+ + group: 'overview'
68
+ ```
69
+
70
+ - 06d1226: Allow providing `kind` parameters to replace the default `Component` kind for `SubComponents` card
71
+
72
+ ### Patch Changes
73
+
74
+ - 31731b0: Internal refactor to avoid `expiry-map` dependency.
75
+ - ba9649a: Update the default entity page extension component to support grouping multiple entity content items in the same tab.
76
+
77
+ Disable all default groups:
78
+
79
+ ```diff
80
+ # app-config.yaml
81
+ app:
82
+ extensions:
83
+ # Pages
84
+ + - page:catalog/entity:
85
+ + config:
86
+ + groups: []
87
+ ```
88
+
89
+ Create a custom list of :
90
+
91
+ ```diff
92
+ # app-config.yaml
93
+ app:
94
+ extensions:
95
+ # Pages
96
+ + - page:catalog/entity:
97
+ + config:
98
+ + groups:
99
+ + # This array of groups completely replaces the default groups
100
+ + - custom:
101
+ + title: 'Custom'
102
+ ```
103
+
104
+ - Updated dependencies
105
+ - @backstage/core-components@0.17.0
106
+ - @backstage/core-plugin-api@1.10.5
107
+ - @backstage/plugin-search-react@1.8.7
108
+ - @backstage/frontend-plugin-api@0.10.0
109
+ - @backstage/plugin-catalog-react@1.16.0
110
+ - @backstage/core-compat-api@0.4.0
111
+ - @backstage/plugin-scaffolder-common@1.5.10
112
+ - @backstage/integration-react@1.2.5
113
+ - @backstage/plugin-permission-react@0.4.32
114
+ - @backstage/catalog-client@1.9.1
115
+ - @backstage/catalog-model@1.7.3
116
+ - @backstage/errors@1.2.7
117
+ - @backstage/types@1.2.1
118
+ - @backstage/plugin-catalog-common@1.1.3
119
+ - @backstage/plugin-search-common@1.2.17
120
+
3
121
  ## 1.28.0-next.2
4
122
 
5
123
  ### Minor Changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog",
3
- "version": "1.28.0-next.2",
3
+ "version": "1.28.0",
4
4
  "description": "The Backstage plugin for browsing the Backstage catalog",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -70,21 +70,21 @@
70
70
  "test": "backstage-cli package test"
71
71
  },
72
72
  "dependencies": {
73
- "@backstage/catalog-client": "1.9.1",
74
- "@backstage/catalog-model": "1.7.3",
75
- "@backstage/core-compat-api": "0.4.0-next.2",
76
- "@backstage/core-components": "0.16.5-next.1",
77
- "@backstage/core-plugin-api": "1.10.4",
78
- "@backstage/errors": "1.2.7",
79
- "@backstage/frontend-plugin-api": "0.10.0-next.2",
80
- "@backstage/integration-react": "1.2.5-next.0",
81
- "@backstage/plugin-catalog-common": "1.1.3",
82
- "@backstage/plugin-catalog-react": "1.16.0-next.2",
83
- "@backstage/plugin-permission-react": "0.4.31",
84
- "@backstage/plugin-scaffolder-common": "1.5.10-next.0",
85
- "@backstage/plugin-search-common": "1.2.17",
86
- "@backstage/plugin-search-react": "1.8.7-next.2",
87
- "@backstage/types": "1.2.1",
73
+ "@backstage/catalog-client": "^1.9.1",
74
+ "@backstage/catalog-model": "^1.7.3",
75
+ "@backstage/core-compat-api": "^0.4.0",
76
+ "@backstage/core-components": "^0.17.0",
77
+ "@backstage/core-plugin-api": "^1.10.5",
78
+ "@backstage/errors": "^1.2.7",
79
+ "@backstage/frontend-plugin-api": "^0.10.0",
80
+ "@backstage/integration-react": "^1.2.5",
81
+ "@backstage/plugin-catalog-common": "^1.1.3",
82
+ "@backstage/plugin-catalog-react": "^1.16.0",
83
+ "@backstage/plugin-permission-react": "^0.4.32",
84
+ "@backstage/plugin-scaffolder-common": "^1.5.10",
85
+ "@backstage/plugin-search-common": "^1.2.17",
86
+ "@backstage/plugin-search-react": "^1.8.7",
87
+ "@backstage/types": "^1.2.1",
88
88
  "@material-ui/core": "^4.12.2",
89
89
  "@material-ui/icons": "^4.9.1",
90
90
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -99,12 +99,12 @@
99
99
  "zen-observable": "^0.10.0"
100
100
  },
101
101
  "devDependencies": {
102
- "@backstage/cli": "0.31.0-next.1",
103
- "@backstage/core-app-api": "1.16.0-next.0",
104
- "@backstage/dev-utils": "1.1.8-next.2",
105
- "@backstage/frontend-test-utils": "0.3.0-next.2",
106
- "@backstage/plugin-permission-common": "0.8.4",
107
- "@backstage/test-utils": "1.7.6-next.0",
102
+ "@backstage/cli": "^0.31.0",
103
+ "@backstage/core-app-api": "^1.16.0",
104
+ "@backstage/dev-utils": "^1.1.8",
105
+ "@backstage/frontend-test-utils": "^0.3.0",
106
+ "@backstage/plugin-permission-common": "^0.8.4",
107
+ "@backstage/test-utils": "^1.7.6",
108
108
  "@testing-library/dom": "^10.0.0",
109
109
  "@testing-library/jest-dom": "^6.0.0",
110
110
  "@testing-library/react": "^16.0.0",