@backstage/plugin-scaffolder-backend-module-cookiecutter 0.3.0-next.1 → 0.3.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 (3) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +6 -23
  3. package/package.json +9 -9
package/CHANGELOG.md CHANGED
@@ -1,5 +1,43 @@
1
1
  # @backstage/plugin-scaffolder-backend-module-cookiecutter
2
2
 
3
+ ## 0.3.0
4
+
5
+ ### Minor Changes
6
+
7
+ - d425fc4: **BREAKING**: The return values from `createBackendPlugin`, `createBackendModule`, and `createServiceFactory` are now simply `BackendFeature` and `ServiceFactory`, instead of the previously deprecated form of a function that returns them. For this reason, `createServiceFactory` also no longer accepts the callback form where you provide direct options to the service. This also affects all `coreServices.*` service refs.
8
+
9
+ This may in particular affect tests; if you were effectively doing `createBackendModule({...})()` (note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in your `packages/backend/src/index.ts` too, where you add plugins, modules, and services. If you were using `createServiceFactory` with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.
10
+
11
+ As part of this change, the `IdentityFactoryOptions` type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to [migrate to the new auth system](https://backstage.io/docs/tutorials/auth-service-migration) if you still rely on it.
12
+
13
+ ### Patch Changes
14
+
15
+ - 5d1670f: Update README installation instructions
16
+ - Updated dependencies
17
+ - @backstage/backend-defaults@0.5.0
18
+ - @backstage/backend-common@0.25.0
19
+ - @backstage/backend-plugin-api@1.0.0
20
+ - @backstage/integration@1.15.0
21
+ - @backstage/config@1.2.0
22
+ - @backstage/errors@1.2.4
23
+ - @backstage/types@1.1.1
24
+ - @backstage/plugin-scaffolder-node@0.4.11
25
+
26
+ ## 0.3.0-next.2
27
+
28
+ ### Patch Changes
29
+
30
+ - 5d1670f: Update README installation instructions
31
+ - Updated dependencies
32
+ - @backstage/backend-common@0.25.0-next.2
33
+ - @backstage/backend-defaults@0.5.0-next.2
34
+ - @backstage/backend-plugin-api@1.0.0-next.2
35
+ - @backstage/integration@1.15.0-next.0
36
+ - @backstage/config@1.2.0
37
+ - @backstage/errors@1.2.4
38
+ - @backstage/types@1.1.1
39
+ - @backstage/plugin-scaffolder-node@0.4.11-next.2
40
+
3
41
  ## 0.3.0-next.1
4
42
 
5
43
  ### Patch Changes
package/README.md CHANGED
@@ -13,31 +13,14 @@ You need to configure the action in your backend:
13
13
  yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-cookiecutter
14
14
  ```
15
15
 
16
- Configure the action:
17
- (you can check the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to see all options):
16
+ Then ensure that both the scaffolder and this module are added to your backend:
18
17
 
19
18
  ```typescript
20
- // packages/backend/src/plugins/scaffolder.ts
21
-
22
- const actions = [
23
- createFetchCookiecutterAction({
24
- integrations,
25
- reader: env.reader,
26
- }),
27
- ...createBuiltInActions({
28
- ...
29
- })
30
- ];
31
-
32
- return await createRouter({
33
- containerRunner,
34
- catalogClient,
35
- actions,
36
- logger: env.logger,
37
- config: env.config,
38
- database: env.database,
39
- reader: env.reader,
40
- });
19
+ // In packages/backend/src/index.ts
20
+ const backend = createBackend();
21
+ // ...
22
+ backend.add(import('@backstage/plugin-scaffolder-backend/alpha'));
23
+ backend.add(import('@backstage/plugin-scaffolder-backend-module-cookiecutter'));
41
24
  ```
42
25
 
43
26
  After that you can use the action in your template:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend-module-cookiecutter",
3
- "version": "0.3.0-next.1",
3
+ "version": "0.3.0",
4
4
  "description": "A module for the scaffolder backend that lets you template projects using cookiecutter",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -40,13 +40,13 @@
40
40
  "test": "backstage-cli package test"
41
41
  },
42
42
  "dependencies": {
43
- "@backstage/backend-common": "^0.25.0-next.1",
44
- "@backstage/backend-defaults": "^0.5.0-next.1",
45
- "@backstage/backend-plugin-api": "^0.9.0-next.1",
43
+ "@backstage/backend-common": "^0.25.0",
44
+ "@backstage/backend-defaults": "^0.5.0",
45
+ "@backstage/backend-plugin-api": "^1.0.0",
46
46
  "@backstage/config": "^1.2.0",
47
47
  "@backstage/errors": "^1.2.4",
48
- "@backstage/integration": "^1.14.0",
49
- "@backstage/plugin-scaffolder-node": "^0.4.11-next.1",
48
+ "@backstage/integration": "^1.15.0",
49
+ "@backstage/plugin-scaffolder-node": "^0.4.11",
50
50
  "@backstage/types": "^1.1.1",
51
51
  "command-exists": "^1.2.9",
52
52
  "fs-extra": "^11.2.0",
@@ -55,9 +55,9 @@
55
55
  "yn": "^4.0.0"
56
56
  },
57
57
  "devDependencies": {
58
- "@backstage/backend-test-utils": "^0.6.0-next.1",
59
- "@backstage/cli": "^0.27.1-next.1",
60
- "@backstage/plugin-scaffolder-node-test-utils": "^0.1.12-next.1",
58
+ "@backstage/backend-test-utils": "^1.0.0",
59
+ "@backstage/cli": "^0.27.1",
60
+ "@backstage/plugin-scaffolder-node-test-utils": "^0.1.12",
61
61
  "@types/command-exists": "^1.2.0",
62
62
  "@types/fs-extra": "^11.0.0"
63
63
  }