@backstage/plugin-scaffolder-backend 2.0.0-next.2 → 2.0.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 +138 -0
  2. package/package.json +30 -30
package/CHANGELOG.md CHANGED
@@ -1,5 +1,143 @@
1
1
  # @backstage/plugin-scaffolder-backend
2
2
 
3
+ ## 2.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - 33394db: **BREAKING CHANGES**
8
+
9
+ Removal of deprecated re-exports from module packages.
10
+
11
+ The following functions have been re-exported from the `scaffolder-backend` plugin for quite some time, and now it's time to clean them up. They've been moved as follows:
12
+
13
+ - `createPublishAzureAction` should be imported from `@backstage/plugin-scaffolder-backend-module-azure` instead.
14
+
15
+ - `createPublishBitbucketCloudAction` should be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket-cloud` instead.
16
+
17
+ - `createPublishBitbucketServerAction` and `createPublishBitbucketServerPullRequestAction` can be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket-server` instead.
18
+
19
+ - `createPublishBitbucketAction` should be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket` instead.
20
+
21
+ - `createPublishGerritAction` and `createPublishGerritReviewAction` can be imported from `@backstage/plugin-scaffolder-backend-module-gerrit` instead.
22
+
23
+ - `createGithubActionsDispatchAction`, `createGithubDeployKeyAction`, `createGithubEnvironmentAction`, `createGithubIssuesLabelAction`, `CreateGithubPullRequestActionOptions`, `createGithubRepoCreateAction`, `createGithubRepoPushAction`, `createGithubWebhookAction`, and `createPublishGithubAction` can be imported from `@backstage/plugin-scaffolder-backend-module-github` instead.
24
+
25
+ - `createPublishGitlabAction` should be imported from `@backstage/plugin-scaffolder-backend-module-gitlab` instead.
26
+
27
+ - `ActionContext`. `createTemplateAction`, `executeShellCommand`, `ExecuteShellCommandOptions`, `fetchContents`, `TaskSecrets`, and `TemplateAction` should be imported from `@backstage/plugin-scaffolder-node` instead.
28
+
29
+ - `ScaffolderEntitiesProcessor` should be imported from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead.
30
+
31
+ - a8fcf04: **BREAKING ALPHA**: The `/alpha` export no longer exports the plugin. Please use `import('@backstage/plugin-scaffolder-backend')` instead as this has been removed.
32
+
33
+ **BREAKING CHANGES**: The old `createRouter` function which was used in the old backend system has been removed along with the `RouterOptions` type.
34
+
35
+ - 73b94d7: **BREAKING CHANGES**
36
+
37
+ The following functions have been re-exported from the `scaffolder-backend` plugin for quite some time, and now it's time to clean them up. They've been moved as follows:
38
+
39
+ - `SerializedTask`, `SerializedTaskEvent`, `TaskBroker`, `TaskBrokerDispatchOptions`, `TaskBrokerDispatchResult`, `TaskCompletionState`, `TaskContext`, `TaskEventType`, `TaskStatus`, `TemplateFilter`, and `TemplateGlobal` should be imported from `@backstage/plugin-scaffolder-node` instead.
40
+
41
+ - The deprecated `copyWithoutRender` option has been removed from `fetch:template` action. You should rename the option to `copyWithoutTemplating` instead.
42
+
43
+ - 5863b04: **BREAKING CHANGES**
44
+
45
+ - The `createBuiltinActions` method has been removed, as this should no longer be needed with the new backend system route, and was only useful when passing the default list of actions again in the old backend system. You should be able to rely on the default behaviour of the new backend system which is to merge the actions.
46
+
47
+ - The `createCatalogRegisterAction` and `createFetchCatalogEntityAction` actions no longer require an `AuthService`, and now accepts a `CatalogService` instead of `CatalogClient`.
48
+
49
+ Unless you're providing your own override action to the default, this should be a non-breaking change.
50
+
51
+ You can migrate using the following if you're getting typescript errors:
52
+
53
+ ```ts
54
+ import { catalogServiceRef } from '@backstage/plugin-catalog-node';
55
+ import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
56
+
57
+ export const myModule = createBackendModule({
58
+ pluginId: 'scaffolder',
59
+ moduleId: 'test',
60
+ register({ registerInit }) {
61
+ registerInit({
62
+ deps: {
63
+ scaffolder: scaffolderActionsExtensionPoint,
64
+ catalog: catalogServiceRef,
65
+ },
66
+ async init({ scaffolder, catalog }) {
67
+ scaffolder.addActions(
68
+ createCatalogRegisterAction({
69
+ catalog,
70
+ }),
71
+ createFetchCatalogEntityAction({
72
+ catalog,
73
+ integrations,
74
+ }),
75
+ );
76
+ },
77
+ });
78
+ },
79
+ });
80
+ ```
81
+
82
+ ### Minor Changes
83
+
84
+ - 73b94d7: **DEPRECATIONS**
85
+
86
+ The following types and implementations have been deprecated, either because they're no longer relevant, or because upcoming changes to the `scaffolder-backend` after `2.0.0` will influence the changes to these API surfaces.
87
+
88
+ - `CreateWorkerOptions`
89
+ - `DatabaseTaskStore`
90
+ - `DatabaseTaskStoreOptions`
91
+ - `TaskManager`
92
+ - `TaskStoreCreateTaskOptions`
93
+ - `TaskStoreCreateTaskResult`
94
+ - `TaskStoreEmitOptions`
95
+ - `TaskStoreListEventsOptions`
96
+ - `TaskStoreRecoverTaskOptions`
97
+ - `TaskStoreShutDownTaskOptions`
98
+
99
+ There is no current path off deprecation, these types are going to be removed and rethought with a better way to define workers in the new backend system.
100
+
101
+ ### Patch Changes
102
+
103
+ - 89a941d: Migrating to latest action format
104
+ - 023629e: Enable usage of secrets within 'each' step of software templates. For example, you can now structure your `each` step like this:
105
+
106
+ ```
107
+ each:
108
+ [
109
+ { name: "Service1", token: "${{ secrets.token1 }}" },
110
+ { name: "Service2", token: "${{ secrets.token2 }}" },
111
+ ]
112
+ ```
113
+
114
+ - e92e481: Add tests for Scaffolder
115
+ - Updated dependencies
116
+ - @backstage/plugin-scaffolder-backend-module-gitlab@0.9.2
117
+ - @backstage/plugin-scaffolder-backend-module-azure@0.2.10
118
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.2.10
119
+ - @backstage/plugin-scaffolder-backend-module-github@0.8.0
120
+ - @backstage/backend-defaults@0.11.0
121
+ - @backstage/plugin-scaffolder-node@0.9.0
122
+ - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.2.10
123
+ - @backstage/plugin-scaffolder-backend-module-gerrit@0.2.10
124
+ - @backstage/plugin-catalog-node@1.17.1
125
+ - @backstage/plugin-auth-node@0.6.4
126
+ - @backstage/plugin-scaffolder-backend-module-gitea@0.2.10
127
+ - @backstage/plugin-scaffolder-backend-module-bitbucket@0.3.11
128
+ - @backstage/backend-plugin-api@1.4.0
129
+ - @backstage/catalog-model@1.7.4
130
+ - @backstage/config@1.3.2
131
+ - @backstage/errors@1.2.7
132
+ - @backstage/integration@1.17.0
133
+ - @backstage/types@1.2.1
134
+ - @backstage/plugin-bitbucket-cloud-common@0.3.0
135
+ - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.2.9
136
+ - @backstage/plugin-events-node@0.4.12
137
+ - @backstage/plugin-permission-common@0.9.0
138
+ - @backstage/plugin-permission-node@0.10.1
139
+ - @backstage/plugin-scaffolder-common@1.5.11
140
+
3
141
  ## 2.0.0-next.2
4
142
 
5
143
  ### Major Changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend",
3
- "version": "2.0.0-next.2",
3
+ "version": "2.0.0",
4
4
  "description": "The Backstage backend plugin that helps you create new things",
5
5
  "backstage": {
6
6
  "role": "backend-plugin",
@@ -74,30 +74,30 @@
74
74
  },
75
75
  "dependencies": {
76
76
  "@backstage/backend-common": "^0.25.0",
77
- "@backstage/backend-defaults": "0.11.0-next.2",
78
- "@backstage/backend-plugin-api": "1.4.0-next.1",
79
- "@backstage/catalog-model": "1.7.4",
80
- "@backstage/config": "1.3.2",
81
- "@backstage/errors": "1.2.7",
82
- "@backstage/integration": "1.17.0",
83
- "@backstage/plugin-auth-node": "0.6.4-next.1",
84
- "@backstage/plugin-bitbucket-cloud-common": "0.3.0",
85
- "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "0.2.9-next.1",
86
- "@backstage/plugin-catalog-node": "1.17.1-next.1",
87
- "@backstage/plugin-events-node": "0.4.12-next.1",
88
- "@backstage/plugin-permission-common": "0.9.0",
89
- "@backstage/plugin-permission-node": "0.10.1-next.1",
90
- "@backstage/plugin-scaffolder-backend-module-azure": "0.2.10-next.2",
91
- "@backstage/plugin-scaffolder-backend-module-bitbucket": "0.3.11-next.2",
92
- "@backstage/plugin-scaffolder-backend-module-bitbucket-cloud": "0.2.10-next.2",
93
- "@backstage/plugin-scaffolder-backend-module-bitbucket-server": "0.2.10-next.2",
94
- "@backstage/plugin-scaffolder-backend-module-gerrit": "0.2.10-next.2",
95
- "@backstage/plugin-scaffolder-backend-module-gitea": "0.2.10-next.2",
96
- "@backstage/plugin-scaffolder-backend-module-github": "0.8.0-next.2",
97
- "@backstage/plugin-scaffolder-backend-module-gitlab": "0.9.2-next.2",
98
- "@backstage/plugin-scaffolder-common": "1.5.11",
99
- "@backstage/plugin-scaffolder-node": "0.9.0-next.2",
100
- "@backstage/types": "1.2.1",
77
+ "@backstage/backend-defaults": "^0.11.0",
78
+ "@backstage/backend-plugin-api": "^1.4.0",
79
+ "@backstage/catalog-model": "^1.7.4",
80
+ "@backstage/config": "^1.3.2",
81
+ "@backstage/errors": "^1.2.7",
82
+ "@backstage/integration": "^1.17.0",
83
+ "@backstage/plugin-auth-node": "^0.6.4",
84
+ "@backstage/plugin-bitbucket-cloud-common": "^0.3.0",
85
+ "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.2.9",
86
+ "@backstage/plugin-catalog-node": "^1.17.1",
87
+ "@backstage/plugin-events-node": "^0.4.12",
88
+ "@backstage/plugin-permission-common": "^0.9.0",
89
+ "@backstage/plugin-permission-node": "^0.10.1",
90
+ "@backstage/plugin-scaffolder-backend-module-azure": "^0.2.10",
91
+ "@backstage/plugin-scaffolder-backend-module-bitbucket": "^0.3.11",
92
+ "@backstage/plugin-scaffolder-backend-module-bitbucket-cloud": "^0.2.10",
93
+ "@backstage/plugin-scaffolder-backend-module-bitbucket-server": "^0.2.10",
94
+ "@backstage/plugin-scaffolder-backend-module-gerrit": "^0.2.10",
95
+ "@backstage/plugin-scaffolder-backend-module-gitea": "^0.2.10",
96
+ "@backstage/plugin-scaffolder-backend-module-github": "^0.8.0",
97
+ "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.9.2",
98
+ "@backstage/plugin-scaffolder-common": "^1.5.11",
99
+ "@backstage/plugin-scaffolder-node": "^0.9.0",
100
+ "@backstage/types": "^1.2.1",
101
101
  "@opentelemetry/api": "^1.9.0",
102
102
  "@types/luxon": "^3.0.0",
103
103
  "concat-stream": "^2.0.0",
@@ -127,11 +127,11 @@
127
127
  "zod-to-json-schema": "^3.20.4"
128
128
  },
129
129
  "devDependencies": {
130
- "@backstage/backend-app-api": "1.2.4-next.2",
131
- "@backstage/backend-defaults": "0.11.0-next.2",
132
- "@backstage/backend-test-utils": "1.6.0-next.2",
133
- "@backstage/cli": "0.33.0-next.1",
134
- "@backstage/plugin-scaffolder-node-test-utils": "0.3.0-next.2",
130
+ "@backstage/backend-app-api": "^1.2.4",
131
+ "@backstage/backend-defaults": "^0.11.0",
132
+ "@backstage/backend-test-utils": "^1.6.0",
133
+ "@backstage/cli": "^0.33.0",
134
+ "@backstage/plugin-scaffolder-node-test-utils": "^0.3.0",
135
135
  "@types/express": "^4.17.6",
136
136
  "@types/fs-extra": "^11.0.0",
137
137
  "@types/nunjucks": "^3.1.4",