@backstage/create-app 0.4.21 → 0.4.22
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 +81 -0
- package/dist/index.cjs.js +40 -40
- package/package.json +2 -2
- package/templates/default-app/packages/app/src/App.tsx +2 -5
- package/templates/default-app/packages/app/src/components/search/SearchPage.tsx +2 -2
- package/templates/default-app/packages/backend/src/plugins/search.ts +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,86 @@
|
|
|
1
1
|
# @backstage/create-app
|
|
2
2
|
|
|
3
|
+
## 0.4.22
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- ee3d6c6f10: Update the template to reflect the renaming of `DocsResultListItem` to `TechDocsSearchResultListItem` from `@backstage/plugin-techdocs`.
|
|
8
|
+
|
|
9
|
+
To apply this change to an existing app, make the following change to `packages/app/src/components/search/SearchPage.tsx`:
|
|
10
|
+
|
|
11
|
+
```diff
|
|
12
|
+
-import { DocsResultListItem } from '@backstage/plugin-techdocs';
|
|
13
|
+
+import { TechDocsSearchResultListItem } from '@backstage/plugin-techdocs';
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
```diff
|
|
17
|
+
case 'techdocs':
|
|
18
|
+
return (
|
|
19
|
+
- <DocsResultListItem
|
|
20
|
+
+ <TechDocsSearchResultListItem
|
|
21
|
+
key={document.location}
|
|
22
|
+
result={document}
|
|
23
|
+
/>
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The `TechDocsIndexPage` now uses `DefaultTechDocsHome` as fall back if no children is provided as `LegacyTechDocsHome` is marked as deprecated. If you do not use a custom techdocs homepage, you can therefore update your app to the following:
|
|
27
|
+
|
|
28
|
+
```diff
|
|
29
|
+
- <Route path="/docs" element={<TechDocsIndexPage />}>
|
|
30
|
+
- <DefaultTechDocsHome />
|
|
31
|
+
- </Route>
|
|
32
|
+
+ <Route path="/docs" element={<TechDocsIndexPage />} />
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
- 617a132871: Update import location of catalogEntityCreatePermission.
|
|
36
|
+
|
|
37
|
+
To apply this change to an existing app, make the following change to `packages/app/src/App.tsx`:
|
|
38
|
+
|
|
39
|
+
```diff
|
|
40
|
+
-import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common';
|
|
41
|
+
+import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
- 022507c860: The Backstage Search Platform's indexing process has been rewritten as a stream
|
|
45
|
+
pipeline in order to improve efficiency and performance on large document sets.
|
|
46
|
+
|
|
47
|
+
To take advantage of this, upgrade to the latest version of
|
|
48
|
+
`@backstage/plugin-search-backend-node`, as well as any backend plugins whose
|
|
49
|
+
collators you are using. Then, make the following changes to your
|
|
50
|
+
`/packages/backend/src/plugins/search.ts` file:
|
|
51
|
+
|
|
52
|
+
```diff
|
|
53
|
+
-import { DefaultCatalogCollator } from '@backstage/plugin-catalog-backend';
|
|
54
|
+
-import { DefaultTechDocsCollator } from '@backstage/plugin-techdocs-backend';
|
|
55
|
+
+import { DefaultCatalogCollatorFactory } from '@backstage/plugin-catalog-backend';
|
|
56
|
+
+import { DefaultTechDocsCollatorFactory } from '@backstage/plugin-techdocs-backend';
|
|
57
|
+
|
|
58
|
+
// ...
|
|
59
|
+
|
|
60
|
+
const indexBuilder = new IndexBuilder({ logger, searchEngine });
|
|
61
|
+
|
|
62
|
+
indexBuilder.addCollator({
|
|
63
|
+
defaultRefreshIntervalSeconds: 600,
|
|
64
|
+
- collator: DefaultCatalogCollator.fromConfig(config, { discovery }),
|
|
65
|
+
+ factory: DefaultCatalogCollatorFactory.fromConfig(config, { discovery }),
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
indexBuilder.addCollator({
|
|
69
|
+
defaultRefreshIntervalSeconds: 600,
|
|
70
|
+
- collator: DefaultTechDocsCollator.fromConfig(config, {
|
|
71
|
+
+ factory: DefaultTechDocsCollatorFactory.fromConfig(config, {
|
|
72
|
+
discovery,
|
|
73
|
+
logger,
|
|
74
|
+
}),
|
|
75
|
+
});
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
If you've written custom collators, decorators, or search engines in your
|
|
79
|
+
Backstage backend instance, you will need to re-implement them as readable,
|
|
80
|
+
transform, and writable streams respectively (including factory classes for
|
|
81
|
+
instantiating them). [A how-to guide for refactoring](https://backstage.io/docs/features/search/how-to-guides#rewriting-alpha-style-collators-for-beta)
|
|
82
|
+
existing implementations is available.
|
|
83
|
+
|
|
3
84
|
## 0.4.21
|
|
4
85
|
|
|
5
86
|
### Patch Changes
|
package/dist/index.cjs.js
CHANGED
|
@@ -55,91 +55,91 @@ ${chalk__default["default"].red(`${error}`)}
|
|
|
55
55
|
}
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
-
var version$G = "0.4.
|
|
58
|
+
var version$G = "0.4.22";
|
|
59
59
|
|
|
60
|
-
var version$F = "0.
|
|
60
|
+
var version$F = "0.2.0";
|
|
61
61
|
|
|
62
|
-
var version$E = "0.
|
|
62
|
+
var version$E = "0.12.0";
|
|
63
63
|
|
|
64
|
-
var version$D = "0.1.
|
|
64
|
+
var version$D = "0.1.10";
|
|
65
65
|
|
|
66
|
-
var version$C = "0.
|
|
66
|
+
var version$C = "0.8.0";
|
|
67
67
|
|
|
68
|
-
var version$B = "0.
|
|
68
|
+
var version$B = "0.12.0";
|
|
69
69
|
|
|
70
|
-
var version$A = "0.
|
|
70
|
+
var version$A = "0.15.0";
|
|
71
71
|
|
|
72
72
|
var version$z = "0.1.15";
|
|
73
73
|
|
|
74
|
-
var version$y = "0.
|
|
74
|
+
var version$y = "0.6.0";
|
|
75
75
|
|
|
76
|
-
var version$x = "0.
|
|
76
|
+
var version$x = "0.9.0";
|
|
77
77
|
|
|
78
|
-
var version$w = "0.
|
|
78
|
+
var version$w = "0.8.0";
|
|
79
79
|
|
|
80
80
|
var version$v = "0.2.2";
|
|
81
81
|
|
|
82
|
-
var version$u = "0.1.
|
|
82
|
+
var version$u = "0.1.24";
|
|
83
83
|
|
|
84
|
-
var version$t = "0.
|
|
84
|
+
var version$t = "0.3.0";
|
|
85
85
|
|
|
86
86
|
var version$s = "0.2.15";
|
|
87
87
|
|
|
88
|
-
var version$r = "0.8.
|
|
88
|
+
var version$r = "0.8.1";
|
|
89
89
|
|
|
90
|
-
var version$q = "0.3.
|
|
90
|
+
var version$q = "0.3.28";
|
|
91
91
|
|
|
92
|
-
var version$p = "0.
|
|
92
|
+
var version$p = "0.12.0";
|
|
93
93
|
|
|
94
|
-
var version$o = "0.9.
|
|
94
|
+
var version$o = "0.9.1";
|
|
95
95
|
|
|
96
|
-
var version$n = "0.
|
|
96
|
+
var version$n = "0.2.0";
|
|
97
97
|
|
|
98
|
-
var version$m = "0.
|
|
98
|
+
var version$m = "0.8.0";
|
|
99
99
|
|
|
100
|
-
var version$l = "0.
|
|
100
|
+
var version$l = "0.23.0";
|
|
101
101
|
|
|
102
|
-
var version$k = "0.2.
|
|
102
|
+
var version$k = "0.2.13";
|
|
103
103
|
|
|
104
|
-
var version$j = "0.8.
|
|
104
|
+
var version$j = "0.8.4";
|
|
105
105
|
|
|
106
|
-
var version$i = "0.3.
|
|
106
|
+
var version$i = "0.3.1";
|
|
107
107
|
|
|
108
|
-
var version$h = "0.3.
|
|
108
|
+
var version$h = "0.3.32";
|
|
109
109
|
|
|
110
|
-
var version$g = "0.5.
|
|
110
|
+
var version$g = "0.5.1";
|
|
111
111
|
|
|
112
|
-
var version$f = "0.3.
|
|
112
|
+
var version$f = "0.3.1";
|
|
113
113
|
|
|
114
|
-
var version$e = "0.5.
|
|
114
|
+
var version$e = "0.5.1";
|
|
115
115
|
|
|
116
|
-
var version$d = "0.5.
|
|
116
|
+
var version$d = "0.5.2";
|
|
117
117
|
|
|
118
|
-
var version$c = "0.3.
|
|
118
|
+
var version$c = "0.3.3";
|
|
119
119
|
|
|
120
|
-
var version$b = "0.5.
|
|
120
|
+
var version$b = "0.5.3";
|
|
121
121
|
|
|
122
|
-
var version$a = "0.2.
|
|
122
|
+
var version$a = "0.2.22";
|
|
123
123
|
|
|
124
|
-
var version$9 = "0.1.
|
|
124
|
+
var version$9 = "0.1.25";
|
|
125
125
|
|
|
126
|
-
var version$8 = "0.
|
|
126
|
+
var version$8 = "0.14.0";
|
|
127
127
|
|
|
128
|
-
var version$7 = "0.17.
|
|
128
|
+
var version$7 = "0.17.3";
|
|
129
129
|
|
|
130
|
-
var version$6 = "0.7.
|
|
130
|
+
var version$6 = "0.7.2";
|
|
131
131
|
|
|
132
|
-
var version$5 = "0.4.
|
|
132
|
+
var version$5 = "0.4.6";
|
|
133
133
|
|
|
134
|
-
var version$4 = "0.
|
|
134
|
+
var version$4 = "0.5.0";
|
|
135
135
|
|
|
136
|
-
var version$3 = "0.5.
|
|
136
|
+
var version$3 = "0.5.8";
|
|
137
137
|
|
|
138
|
-
var version$2 = "0.
|
|
138
|
+
var version$2 = "0.15.0";
|
|
139
139
|
|
|
140
|
-
var version$1 = "0.14.
|
|
140
|
+
var version$1 = "0.14.1";
|
|
141
141
|
|
|
142
|
-
var version = "0.
|
|
142
|
+
var version = "0.4.0";
|
|
143
143
|
|
|
144
144
|
const packageVersions = {
|
|
145
145
|
"@backstage/app-defaults": version$F,
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/create-app",
|
|
3
3
|
"description": "A CLI that helps you create your own Backstage app",
|
|
4
|
-
"version": "0.4.
|
|
4
|
+
"version": "0.4.22",
|
|
5
5
|
"private": false,
|
|
6
6
|
"publishConfig": {
|
|
7
7
|
"access": "public"
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"dist",
|
|
61
61
|
"templates"
|
|
62
62
|
],
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "04bb0dd824b78f6b57dac62c3015e681f094045c"
|
|
64
64
|
}
|
|
@@ -15,7 +15,6 @@ import { orgPlugin } from '@backstage/plugin-org';
|
|
|
15
15
|
import { SearchPage } from '@backstage/plugin-search';
|
|
16
16
|
import { TechRadarPage } from '@backstage/plugin-tech-radar';
|
|
17
17
|
import {
|
|
18
|
-
DefaultTechDocsHome,
|
|
19
18
|
TechDocsIndexPage,
|
|
20
19
|
techdocsPlugin,
|
|
21
20
|
TechDocsReaderPage,
|
|
@@ -31,7 +30,7 @@ import { createApp } from '@backstage/app-defaults';
|
|
|
31
30
|
import { FlatRoutes } from '@backstage/core-app-api';
|
|
32
31
|
import { CatalogGraphPage } from '@backstage/plugin-catalog-graph';
|
|
33
32
|
import { PermissionedRoute } from '@backstage/plugin-permission-react';
|
|
34
|
-
import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common';
|
|
33
|
+
import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
|
|
35
34
|
|
|
36
35
|
const app = createApp({
|
|
37
36
|
apis,
|
|
@@ -65,9 +64,7 @@ const routes = (
|
|
|
65
64
|
>
|
|
66
65
|
{entityPage}
|
|
67
66
|
</Route>
|
|
68
|
-
<Route path="/docs" element={<TechDocsIndexPage />}
|
|
69
|
-
<DefaultTechDocsHome />
|
|
70
|
-
</Route>
|
|
67
|
+
<Route path="/docs" element={<TechDocsIndexPage />} />
|
|
71
68
|
<Route
|
|
72
69
|
path="/docs/:namespace/:kind/:name/*"
|
|
73
70
|
element={<TechDocsReaderPage />}
|
|
@@ -6,7 +6,7 @@ import {
|
|
|
6
6
|
catalogApiRef,
|
|
7
7
|
CATALOG_FILTER_EXISTS,
|
|
8
8
|
} from '@backstage/plugin-catalog-react';
|
|
9
|
-
import {
|
|
9
|
+
import { TechDocsSearchResultListItem } from '@backstage/plugin-techdocs';
|
|
10
10
|
|
|
11
11
|
import {
|
|
12
12
|
SearchBar,
|
|
@@ -123,7 +123,7 @@ const SearchPage = () => {
|
|
|
123
123
|
);
|
|
124
124
|
case 'techdocs':
|
|
125
125
|
return (
|
|
126
|
-
<
|
|
126
|
+
<TechDocsSearchResultListItem
|
|
127
127
|
key={document.location}
|
|
128
128
|
result={document}
|
|
129
129
|
/>
|
|
@@ -5,8 +5,8 @@ import {
|
|
|
5
5
|
LunrSearchEngine,
|
|
6
6
|
} from '@backstage/plugin-search-backend-node';
|
|
7
7
|
import { PluginEnvironment } from '../types';
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
8
|
+
import { DefaultCatalogCollatorFactory } from '@backstage/plugin-catalog-backend';
|
|
9
|
+
import { DefaultTechDocsCollatorFactory } from '@backstage/plugin-techdocs-backend';
|
|
10
10
|
|
|
11
11
|
export default async function createPlugin({
|
|
12
12
|
logger,
|
|
@@ -23,7 +23,7 @@ export default async function createPlugin({
|
|
|
23
23
|
// collator gathers entities from the software catalog.
|
|
24
24
|
indexBuilder.addCollator({
|
|
25
25
|
defaultRefreshIntervalSeconds: 600,
|
|
26
|
-
|
|
26
|
+
factory: DefaultCatalogCollatorFactory.fromConfig(config, {
|
|
27
27
|
discovery,
|
|
28
28
|
tokenManager,
|
|
29
29
|
}),
|
|
@@ -32,7 +32,7 @@ export default async function createPlugin({
|
|
|
32
32
|
// collator gathers entities from techdocs.
|
|
33
33
|
indexBuilder.addCollator({
|
|
34
34
|
defaultRefreshIntervalSeconds: 600,
|
|
35
|
-
|
|
35
|
+
factory: DefaultTechDocsCollatorFactory.fromConfig(config, {
|
|
36
36
|
discovery,
|
|
37
37
|
logger,
|
|
38
38
|
tokenManager,
|