@backstage/create-app 0.0.0-nightly-2021102522541 → 0.0.0-nightly-2021102922210
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 +63 -20
- package/dist/index.cjs.js +20 -20
- package/package.json +3 -35
- package/templates/default-app/app-config.yaml.hbs +5 -0
- package/templates/default-app/packages/backend/src/index.ts +3 -1
- package/templates/default-app/packages/backend/src/plugins/search.ts +10 -2
- package/templates/default-app/packages/backend/src/types.ts +2 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,9 +1,71 @@
|
|
|
1
1
|
# @backstage/create-app
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-2021102922210
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
+
- 905dd952ac: Incorporate usage of the tokenManager into the backend created using `create-app`.
|
|
8
|
+
|
|
9
|
+
In existing backends, update the `PluginEnvironment` to include a `tokenManager`:
|
|
10
|
+
|
|
11
|
+
```diff
|
|
12
|
+
// packages/backend/src/types.ts
|
|
13
|
+
|
|
14
|
+
...
|
|
15
|
+
import {
|
|
16
|
+
...
|
|
17
|
+
+ TokenManager,
|
|
18
|
+
} from '@backstage/backend-common';
|
|
19
|
+
|
|
20
|
+
export type PluginEnvironment = {
|
|
21
|
+
...
|
|
22
|
+
+ tokenManager: TokenManager;
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Then, create a `ServerTokenManager`. This can either be a `noop` that requires no secret and validates all requests by default, or one that uses a secret from your `app-config.yaml` to generate and validate tokens.
|
|
27
|
+
|
|
28
|
+
```diff
|
|
29
|
+
// packages/backend/src/index.ts
|
|
30
|
+
|
|
31
|
+
...
|
|
32
|
+
import {
|
|
33
|
+
...
|
|
34
|
+
+ ServerTokenManager,
|
|
35
|
+
} from '@backstage/backend-common';
|
|
36
|
+
...
|
|
37
|
+
|
|
38
|
+
function makeCreateEnv(config: Config) {
|
|
39
|
+
...
|
|
40
|
+
// CHOOSE ONE
|
|
41
|
+
// TokenManager not requiring a secret
|
|
42
|
+
+ const tokenManager = ServerTokenManager.noop();
|
|
43
|
+
// OR TokenManager requiring a secret
|
|
44
|
+
+ const tokenManager = ServerTokenManager.fromConfig(config);
|
|
45
|
+
|
|
46
|
+
...
|
|
47
|
+
return (plugin: string): PluginEnvironment => {
|
|
48
|
+
...
|
|
49
|
+
- return { logger, cache, database, config, reader, discovery };
|
|
50
|
+
+ return { logger, cache, database, config, reader, discovery, tokenManager };
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
- Updated dependencies
|
|
56
|
+
- @backstage/plugin-auth-backend@0.0.0-nightly-2021102922210
|
|
57
|
+
- @backstage/plugin-catalog-backend@0.0.0-nightly-2021102922210
|
|
58
|
+
- @backstage/plugin-scaffolder-backend@0.0.0-nightly-2021102922210
|
|
59
|
+
- @backstage/plugin-techdocs-backend@0.0.0-nightly-2021102922210
|
|
60
|
+
- @backstage/backend-common@0.0.0-nightly-2021102922210
|
|
61
|
+
- @backstage/cli@0.0.0-nightly-2021102922210
|
|
62
|
+
- @backstage/core-plugin-api@0.0.0-nightly-2021102922210
|
|
63
|
+
|
|
64
|
+
## 0.4.5
|
|
65
|
+
|
|
66
|
+
### Patch Changes
|
|
67
|
+
|
|
68
|
+
- 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.
|
|
7
69
|
- a5a5d7e1f1: DefaultTechDocsCollator is now included in the search backend, and the Search Page updated with the SearchType component that includes the techdocs type
|
|
8
70
|
- bab752e2b3: Change default port of backend from 7000 to 7007.
|
|
9
71
|
|
|
@@ -20,25 +82,6 @@
|
|
|
20
82
|
More information can be found here: https://backstage.io/docs/conf/writing
|
|
21
83
|
|
|
22
84
|
- 42ebbc18c0: Bump gitbeaker to the latest version
|
|
23
|
-
- Updated dependencies
|
|
24
|
-
- @backstage/errors@0.0.0-nightly-2021102522541
|
|
25
|
-
- @backstage/plugin-scaffolder@0.0.0-nightly-2021102522541
|
|
26
|
-
- @backstage/plugin-auth-backend@0.0.0-nightly-2021102522541
|
|
27
|
-
- @backstage/cli@0.0.0-nightly-2021102522541
|
|
28
|
-
- @backstage/plugin-catalog-backend@0.0.0-nightly-2021102522541
|
|
29
|
-
- @backstage/backend-common@0.0.0-nightly-2021102522541
|
|
30
|
-
- @backstage/core-app-api@0.0.0-nightly-2021102522541
|
|
31
|
-
- @backstage/plugin-github-actions@0.0.0-nightly-2021102522541
|
|
32
|
-
- @backstage/plugin-proxy-backend@0.0.0-nightly-2021102522541
|
|
33
|
-
- @backstage/plugin-rollbar-backend@0.0.0-nightly-2021102522541
|
|
34
|
-
- @backstage/plugin-search-backend@0.0.0-nightly-2021102522541
|
|
35
|
-
- @backstage/plugin-techdocs@0.0.0-nightly-2021102522541
|
|
36
|
-
- @backstage/plugin-techdocs-backend@0.0.0-nightly-2021102522541
|
|
37
|
-
- @backstage/plugin-scaffolder-backend@0.0.0-nightly-2021102522541
|
|
38
|
-
- @backstage/core-plugin-api@0.0.0-nightly-2021102522541
|
|
39
|
-
- @backstage/test-utils@0.0.0-nightly-2021102522541
|
|
40
|
-
- @backstage/plugin-api-docs@0.0.0-nightly-2021102522541
|
|
41
|
-
- @backstage/core-components@0.0.0-nightly-2021102522541
|
|
42
85
|
|
|
43
86
|
## 0.4.4
|
|
44
87
|
|
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.0.0-nightly-
|
|
4
|
+
"version": "0.0.0-nightly-2021102922210",
|
|
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/plugin-api-docs": "*",
|
|
58
|
-
"@backstage/plugin-app-backend": "*",
|
|
59
|
-
"@backstage/plugin-auth-backend": "*",
|
|
60
|
-
"@backstage/plugin-catalog": "*",
|
|
61
|
-
"@backstage/plugin-catalog-backend": "*",
|
|
62
|
-
"@backstage/plugin-catalog-import": "*",
|
|
63
|
-
"@backstage/plugin-explore": "*",
|
|
64
|
-
"@backstage/plugin-github-actions": "*",
|
|
65
|
-
"@backstage/plugin-lighthouse": "*",
|
|
66
|
-
"@backstage/plugin-proxy-backend": "*",
|
|
67
|
-
"@backstage/plugin-rollbar-backend": "*",
|
|
68
|
-
"@backstage/plugin-scaffolder": "*",
|
|
69
|
-
"@backstage/plugin-search": "*",
|
|
70
|
-
"@backstage/plugin-search-backend": "*",
|
|
71
|
-
"@backstage/plugin-search-backend-node": "*",
|
|
72
|
-
"@backstage/plugin-scaffolder-backend": "*",
|
|
73
|
-
"@backstage/plugin-tech-radar": "*",
|
|
74
|
-
"@backstage/plugin-techdocs": "*",
|
|
75
|
-
"@backstage/plugin-techdocs-backend": "*",
|
|
76
|
-
"@backstage/plugin-user-settings": "*",
|
|
77
|
-
"@backstage/integration-react": "*",
|
|
78
|
-
"@backstage/test-utils": "*",
|
|
79
|
-
"@backstage/theme": "*"
|
|
80
|
-
},
|
|
81
49
|
"nodemonConfig": {
|
|
82
50
|
"watch": "./src",
|
|
83
51
|
"exec": "bin/backstage-create-app",
|
|
@@ -6,6 +6,11 @@ organization:
|
|
|
6
6
|
name: My Company
|
|
7
7
|
|
|
8
8
|
backend:
|
|
9
|
+
# Used for enabling authentication, secret is shared by all backend plugins
|
|
10
|
+
# See backend-to-backend-auth.md in the docs for information on the format
|
|
11
|
+
# auth:
|
|
12
|
+
# keys:
|
|
13
|
+
# - secret: ${BACKEND_SECRET}
|
|
9
14
|
baseUrl: http://localhost:7007
|
|
10
15
|
listen:
|
|
11
16
|
port: 7007
|
|
@@ -17,6 +17,7 @@ import {
|
|
|
17
17
|
DatabaseManager,
|
|
18
18
|
SingleHostDiscovery,
|
|
19
19
|
UrlReaders,
|
|
20
|
+
ServerTokenManager,
|
|
20
21
|
} from '@backstage/backend-common';
|
|
21
22
|
import { Config } from '@backstage/config';
|
|
22
23
|
import app from './plugins/app';
|
|
@@ -37,12 +38,13 @@ function makeCreateEnv(config: Config) {
|
|
|
37
38
|
|
|
38
39
|
const cacheManager = CacheManager.fromConfig(config);
|
|
39
40
|
const databaseManager = DatabaseManager.fromConfig(config);
|
|
41
|
+
const tokenManager = ServerTokenManager.noop();
|
|
40
42
|
|
|
41
43
|
return (plugin: string): PluginEnvironment => {
|
|
42
44
|
const logger = root.child({ type: 'plugin', plugin });
|
|
43
45
|
const database = databaseManager.forPlugin(plugin);
|
|
44
46
|
const cache = cacheManager.forPlugin(plugin);
|
|
45
|
-
return { logger, database, cache, config, reader, discovery };
|
|
47
|
+
return { logger, database, cache, config, reader, discovery, tokenManager };
|
|
46
48
|
};
|
|
47
49
|
}
|
|
48
50
|
|
|
@@ -12,6 +12,7 @@ export default async function createPlugin({
|
|
|
12
12
|
logger,
|
|
13
13
|
discovery,
|
|
14
14
|
config,
|
|
15
|
+
tokenManager,
|
|
15
16
|
}: PluginEnvironment) {
|
|
16
17
|
// Initialize a connection to a search engine.
|
|
17
18
|
const searchEngine = new LunrSearchEngine({ logger });
|
|
@@ -21,13 +22,20 @@ export default async function createPlugin({
|
|
|
21
22
|
// collator gathers entities from the software catalog.
|
|
22
23
|
indexBuilder.addCollator({
|
|
23
24
|
defaultRefreshIntervalSeconds: 600,
|
|
24
|
-
collator: DefaultCatalogCollator.fromConfig(config, {
|
|
25
|
+
collator: DefaultCatalogCollator.fromConfig(config, {
|
|
26
|
+
discovery,
|
|
27
|
+
tokenManager,
|
|
28
|
+
}),
|
|
25
29
|
});
|
|
26
30
|
|
|
27
31
|
// collator gathers entities from techdocs.
|
|
28
32
|
indexBuilder.addCollator({
|
|
29
33
|
defaultRefreshIntervalSeconds: 600,
|
|
30
|
-
collator: DefaultTechDocsCollator.fromConfig(config, {
|
|
34
|
+
collator: DefaultTechDocsCollator.fromConfig(config, {
|
|
35
|
+
discovery,
|
|
36
|
+
logger,
|
|
37
|
+
tokenManager,
|
|
38
|
+
}),
|
|
31
39
|
});
|
|
32
40
|
|
|
33
41
|
// The scheduler controls when documents are gathered from collators and sent
|
|
@@ -4,6 +4,7 @@ import {
|
|
|
4
4
|
PluginCacheManager,
|
|
5
5
|
PluginDatabaseManager,
|
|
6
6
|
PluginEndpointDiscovery,
|
|
7
|
+
TokenManager,
|
|
7
8
|
UrlReader,
|
|
8
9
|
} from '@backstage/backend-common';
|
|
9
10
|
|
|
@@ -14,4 +15,5 @@ export type PluginEnvironment = {
|
|
|
14
15
|
config: Config;
|
|
15
16
|
reader: UrlReader;
|
|
16
17
|
discovery: PluginEndpointDiscovery;
|
|
18
|
+
tokenManager: TokenManager;
|
|
17
19
|
};
|