@backstage/create-app 0.4.4 → 0.4.5
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 +22 -0
- package/dist/index.cjs.js +20 -20
- package/package.json +4 -36
- package/templates/default-app/app-config.production.yaml +3 -3
- package/templates/default-app/app-config.yaml.hbs +5 -3
- package/templates/default-app/packages/app/src/App.test.tsx +2 -2
- package/templates/default-app/packages/app/src/components/search/SearchPage.tsx +15 -0
- package/templates/default-app/packages/backend/README.md +1 -1
- package/templates/default-app/packages/backend/package.json.hbs +1 -1
- package/templates/default-app/packages/backend/src/plugins/search.ts +8 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# @backstage/create-app
|
|
2
2
|
|
|
3
|
+
## 0.4.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- dcaeaac174: Cleaned out the `peerDependencies` in the published version of the package, making it much quicker to run `npx @backstage/create-app` as it no longer needs to install a long list of unnecessary.
|
|
8
|
+
- a5a5d7e1f1: DefaultTechDocsCollator is now included in the search backend, and the Search Page updated with the SearchType component that includes the techdocs type
|
|
9
|
+
- bab752e2b3: Change default port of backend from 7000 to 7007.
|
|
10
|
+
|
|
11
|
+
This is due to the AirPlay Receiver process occupying port 7000 and preventing local Backstage instances on MacOS to start.
|
|
12
|
+
|
|
13
|
+
You can change the port back to 7000 or any other value by providing an `app-config.yaml` with the following values:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
backend:
|
|
17
|
+
listen: 0.0.0.0:7123
|
|
18
|
+
baseUrl: http://localhost:7123
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
More information can be found here: https://backstage.io/docs/conf/writing
|
|
22
|
+
|
|
23
|
+
- 42ebbc18c0: Bump gitbeaker to the latest version
|
|
24
|
+
|
|
3
25
|
## 0.4.4
|
|
4
26
|
|
|
5
27
|
### Patch Changes
|
package/dist/index.cjs.js
CHANGED
|
@@ -55,45 +55,45 @@ ${chalk__default['default'].red(`${error}`)}
|
|
|
55
55
|
}
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
-
var version$A = "0.4.
|
|
58
|
+
var version$A = "0.4.5";
|
|
59
59
|
|
|
60
60
|
var version$z = "0.1.1";
|
|
61
61
|
|
|
62
|
-
var version$y = "0.9.
|
|
62
|
+
var version$y = "0.9.11";
|
|
63
63
|
|
|
64
64
|
var version$x = "0.5.2";
|
|
65
65
|
|
|
66
66
|
var version$w = "0.9.7";
|
|
67
67
|
|
|
68
|
-
var version$v = "0.9.
|
|
68
|
+
var version$v = "0.9.1";
|
|
69
69
|
|
|
70
70
|
var version$u = "0.1.11";
|
|
71
71
|
|
|
72
|
-
var version$t = "0.1.
|
|
72
|
+
var version$t = "0.1.23";
|
|
73
73
|
|
|
74
|
-
var version$s = "0.7.
|
|
74
|
+
var version$s = "0.7.5";
|
|
75
75
|
|
|
76
|
-
var version$r = "0.2.
|
|
76
|
+
var version$r = "0.2.1";
|
|
77
77
|
|
|
78
|
-
var version$q = "0.1.
|
|
78
|
+
var version$q = "0.1.5";
|
|
79
79
|
|
|
80
80
|
var version$p = "0.1.14";
|
|
81
81
|
|
|
82
|
-
var version$o = "0.1.
|
|
82
|
+
var version$o = "0.1.23";
|
|
83
83
|
|
|
84
84
|
var version$n = "0.2.13";
|
|
85
85
|
|
|
86
|
-
var version$m = "0.6.
|
|
86
|
+
var version$m = "0.6.15";
|
|
87
87
|
|
|
88
88
|
var version$l = "0.3.19";
|
|
89
89
|
|
|
90
|
-
var version$k = "0.4.
|
|
90
|
+
var version$k = "0.4.9";
|
|
91
91
|
|
|
92
92
|
var version$j = "0.7.3";
|
|
93
93
|
|
|
94
94
|
var version$i = "0.6.4";
|
|
95
95
|
|
|
96
|
-
var version$h = "0.
|
|
96
|
+
var version$h = "0.18.0";
|
|
97
97
|
|
|
98
98
|
var version$g = "0.7.4";
|
|
99
99
|
|
|
@@ -101,31 +101,31 @@ var version$f = "0.2.29";
|
|
|
101
101
|
|
|
102
102
|
var version$e = "0.3.21";
|
|
103
103
|
|
|
104
|
-
var version$d = "0.4.
|
|
104
|
+
var version$d = "0.4.25";
|
|
105
105
|
|
|
106
106
|
var version$c = "0.2.30";
|
|
107
107
|
|
|
108
|
-
var version$b = "0.3.
|
|
108
|
+
var version$b = "0.3.29";
|
|
109
109
|
|
|
110
|
-
var version$a = "0.2.
|
|
110
|
+
var version$a = "0.2.14";
|
|
111
111
|
|
|
112
|
-
var version$9 = "0.1.
|
|
112
|
+
var version$9 = "0.1.16";
|
|
113
113
|
|
|
114
|
-
var version$8 = "0.11.
|
|
114
|
+
var version$8 = "0.11.12";
|
|
115
115
|
|
|
116
|
-
var version$7 = "0.15.
|
|
116
|
+
var version$7 = "0.15.14";
|
|
117
117
|
|
|
118
118
|
var version$6 = "0.4.18";
|
|
119
119
|
|
|
120
|
-
var version$5 = "0.2.
|
|
120
|
+
var version$5 = "0.2.7";
|
|
121
121
|
|
|
122
122
|
var version$4 = "0.4.3";
|
|
123
123
|
|
|
124
124
|
var version$3 = "0.4.12";
|
|
125
125
|
|
|
126
|
-
var version$2 = "0.12.
|
|
126
|
+
var version$2 = "0.12.7";
|
|
127
127
|
|
|
128
|
-
var version$1 = "0.10.
|
|
128
|
+
var version$1 = "0.10.9";
|
|
129
129
|
|
|
130
130
|
var version = "0.3.11";
|
|
131
131
|
|
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.5",
|
|
5
5
|
"private": false,
|
|
6
6
|
"publishConfig": {
|
|
7
7
|
"access": "public"
|
|
@@ -25,6 +25,8 @@
|
|
|
25
25
|
"lint": "backstage-cli lint",
|
|
26
26
|
"test": "backstage-cli test",
|
|
27
27
|
"clean": "backstage-cli clean",
|
|
28
|
+
"prepack": "node scripts/prepack.js",
|
|
29
|
+
"postpack": "node scripts/postpack.js",
|
|
28
30
|
"start": "nodemon --"
|
|
29
31
|
},
|
|
30
32
|
"dependencies": {
|
|
@@ -44,40 +46,6 @@
|
|
|
44
46
|
"mock-fs": "^5.1.1",
|
|
45
47
|
"ts-node": "^10.0.0"
|
|
46
48
|
},
|
|
47
|
-
"peerDependencies": {
|
|
48
|
-
"@backstage/backend-common": "*",
|
|
49
|
-
"@backstage/catalog-client": "*",
|
|
50
|
-
"@backstage/catalog-model": "*",
|
|
51
|
-
"@backstage/cli": "*",
|
|
52
|
-
"@backstage/config": "*",
|
|
53
|
-
"@backstage/core-app-api": "*",
|
|
54
|
-
"@backstage/core-components": "*",
|
|
55
|
-
"@backstage/core-plugin-api": "*",
|
|
56
|
-
"@backstage/errors": "*",
|
|
57
|
-
"@backstage/integration-react": "*",
|
|
58
|
-
"@backstage/plugin-api-docs": "*",
|
|
59
|
-
"@backstage/plugin-app-backend": "*",
|
|
60
|
-
"@backstage/plugin-auth-backend": "*",
|
|
61
|
-
"@backstage/plugin-catalog": "*",
|
|
62
|
-
"@backstage/plugin-catalog-backend": "*",
|
|
63
|
-
"@backstage/plugin-catalog-import": "*",
|
|
64
|
-
"@backstage/plugin-explore": "*",
|
|
65
|
-
"@backstage/plugin-github-actions": "*",
|
|
66
|
-
"@backstage/plugin-lighthouse": "*",
|
|
67
|
-
"@backstage/plugin-proxy-backend": "*",
|
|
68
|
-
"@backstage/plugin-rollbar-backend": "*",
|
|
69
|
-
"@backstage/plugin-scaffolder": "*",
|
|
70
|
-
"@backstage/plugin-scaffolder-backend": "*",
|
|
71
|
-
"@backstage/plugin-search": "*",
|
|
72
|
-
"@backstage/plugin-search-backend": "*",
|
|
73
|
-
"@backstage/plugin-search-backend-node": "*",
|
|
74
|
-
"@backstage/plugin-tech-radar": "*",
|
|
75
|
-
"@backstage/plugin-techdocs": "*",
|
|
76
|
-
"@backstage/plugin-techdocs-backend": "*",
|
|
77
|
-
"@backstage/plugin-user-settings": "*",
|
|
78
|
-
"@backstage/test-utils": "*",
|
|
79
|
-
"@backstage/theme": "*"
|
|
80
|
-
},
|
|
81
49
|
"nodemonConfig": {
|
|
82
50
|
"watch": "./src",
|
|
83
51
|
"exec": "bin/backstage-create-app",
|
|
@@ -88,5 +56,5 @@
|
|
|
88
56
|
"dist",
|
|
89
57
|
"templates"
|
|
90
58
|
],
|
|
91
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "85c127e436a24140bb3606f17f034f82aa9c7c0d"
|
|
92
60
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
app:
|
|
2
2
|
# Should be the same as backend.baseUrl when using the `app-backend` plugin
|
|
3
|
-
baseUrl: http://localhost:
|
|
3
|
+
baseUrl: http://localhost:7007
|
|
4
4
|
|
|
5
5
|
backend:
|
|
6
|
-
baseUrl: http://localhost:
|
|
6
|
+
baseUrl: http://localhost:7007
|
|
7
7
|
listen:
|
|
8
|
-
port:
|
|
8
|
+
port: 7007
|
|
@@ -6,9 +6,9 @@ organization:
|
|
|
6
6
|
name: My Company
|
|
7
7
|
|
|
8
8
|
backend:
|
|
9
|
-
baseUrl: http://localhost:
|
|
9
|
+
baseUrl: http://localhost:7007
|
|
10
10
|
listen:
|
|
11
|
-
port:
|
|
11
|
+
port: 7007
|
|
12
12
|
csp:
|
|
13
13
|
connect-src: ["'self'", 'http:', 'https:']
|
|
14
14
|
# Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
|
|
@@ -32,7 +32,9 @@ backend:
|
|
|
32
32
|
user: ${POSTGRES_USER}
|
|
33
33
|
password: ${POSTGRES_PASSWORD}
|
|
34
34
|
# https://node-postgres.com/features/ssl
|
|
35
|
-
#
|
|
35
|
+
# you can set the sslmode configuration option via the `PGSSLMODE` environment variable
|
|
36
|
+
# see https://www.postgresql.org/docs/current/libpq-ssl.html Table 33.1. SSL Mode Descriptions (e.g. require)
|
|
37
|
+
# ssl:
|
|
36
38
|
# ca: # if you have a CA file and want to verify it you can uncomment this section
|
|
37
39
|
# $file: <file-path>/ca/server.crt
|
|
38
40
|
{{/if}}
|
|
@@ -10,9 +10,9 @@ describe('App', () => {
|
|
|
10
10
|
{
|
|
11
11
|
data: {
|
|
12
12
|
app: { title: 'Test' },
|
|
13
|
-
backend: { baseUrl: 'http://localhost:
|
|
13
|
+
backend: { baseUrl: 'http://localhost:7007' },
|
|
14
14
|
techdocs: {
|
|
15
|
-
storageUrl: 'http://localhost:
|
|
15
|
+
storageUrl: 'http://localhost:7007/api/techdocs/static/docs',
|
|
16
16
|
},
|
|
17
17
|
},
|
|
18
18
|
context: 'test',
|
|
@@ -2,10 +2,13 @@ import React from 'react';
|
|
|
2
2
|
import { makeStyles, Theme, Grid, List, Paper } from '@material-ui/core';
|
|
3
3
|
|
|
4
4
|
import { CatalogResultListItem } from '@backstage/plugin-catalog';
|
|
5
|
+
import { DocsResultListItem } from '@backstage/plugin-techdocs';
|
|
6
|
+
|
|
5
7
|
import {
|
|
6
8
|
SearchBar,
|
|
7
9
|
SearchFilter,
|
|
8
10
|
SearchResult,
|
|
11
|
+
SearchType,
|
|
9
12
|
DefaultResultListItem,
|
|
10
13
|
} from '@backstage/plugin-search';
|
|
11
14
|
import { Content, Header, Page } from '@backstage/core-components';
|
|
@@ -39,6 +42,11 @@ const SearchPage = () => {
|
|
|
39
42
|
</Grid>
|
|
40
43
|
<Grid item xs={3}>
|
|
41
44
|
<Paper className={classes.filters}>
|
|
45
|
+
<SearchType
|
|
46
|
+
values={['techdocs', 'software-catalog']}
|
|
47
|
+
name="type"
|
|
48
|
+
defaultValue="software-catalog"
|
|
49
|
+
/>
|
|
42
50
|
<SearchFilter.Select
|
|
43
51
|
className={classes.filter}
|
|
44
52
|
name="kind"
|
|
@@ -64,6 +72,13 @@ const SearchPage = () => {
|
|
|
64
72
|
result={document}
|
|
65
73
|
/>
|
|
66
74
|
);
|
|
75
|
+
case 'techdocs':
|
|
76
|
+
return (
|
|
77
|
+
<DocsResultListItem
|
|
78
|
+
key={document.location}
|
|
79
|
+
result={document}
|
|
80
|
+
/>
|
|
81
|
+
);
|
|
67
82
|
default:
|
|
68
83
|
return (
|
|
69
84
|
<DefaultResultListItem
|
|
@@ -36,7 +36,7 @@ yarn start
|
|
|
36
36
|
Substitute `x` for actual values, or leave them as dummy values just to try out
|
|
37
37
|
the backend without using the auth or sentry features.
|
|
38
38
|
|
|
39
|
-
The backend starts up on port
|
|
39
|
+
The backend starts up on port 7007 per default.
|
|
40
40
|
|
|
41
41
|
## Populating The Catalog
|
|
42
42
|
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"@backstage/plugin-search-backend": "^{{version '@backstage/plugin-search-backend'}}",
|
|
28
28
|
"@backstage/plugin-search-backend-node": "^{{version '@backstage/plugin-search-backend-node'}}",
|
|
29
29
|
"@backstage/plugin-techdocs-backend": "^{{version '@backstage/plugin-techdocs-backend'}}",
|
|
30
|
-
"@gitbeaker/node": "^
|
|
30
|
+
"@gitbeaker/node": "^34.6.0",
|
|
31
31
|
"@octokit/rest": "^18.5.3",
|
|
32
32
|
"dockerode": "^3.3.1",
|
|
33
33
|
"express": "^4.17.1",
|
|
@@ -6,6 +6,7 @@ import {
|
|
|
6
6
|
} from '@backstage/plugin-search-backend-node';
|
|
7
7
|
import { PluginEnvironment } from '../types';
|
|
8
8
|
import { DefaultCatalogCollator } from '@backstage/plugin-catalog-backend';
|
|
9
|
+
import { DefaultTechDocsCollator } from '@backstage/plugin-techdocs-backend';
|
|
9
10
|
|
|
10
11
|
export default async function createPlugin({
|
|
11
12
|
logger,
|
|
@@ -17,12 +18,18 @@ export default async function createPlugin({
|
|
|
17
18
|
const indexBuilder = new IndexBuilder({ logger, searchEngine });
|
|
18
19
|
|
|
19
20
|
// Collators are responsible for gathering documents known to plugins. This
|
|
20
|
-
//
|
|
21
|
+
// collator gathers entities from the software catalog.
|
|
21
22
|
indexBuilder.addCollator({
|
|
22
23
|
defaultRefreshIntervalSeconds: 600,
|
|
23
24
|
collator: DefaultCatalogCollator.fromConfig(config, { discovery }),
|
|
24
25
|
});
|
|
25
26
|
|
|
27
|
+
// collator gathers entities from techdocs.
|
|
28
|
+
indexBuilder.addCollator({
|
|
29
|
+
defaultRefreshIntervalSeconds: 600,
|
|
30
|
+
collator: DefaultTechDocsCollator.fromConfig(config, { discovery, logger }),
|
|
31
|
+
});
|
|
32
|
+
|
|
26
33
|
// The scheduler controls when documents are gathered from collators and sent
|
|
27
34
|
// to the search engine for indexing.
|
|
28
35
|
const { scheduler } = await indexBuilder.build();
|