Version Packages
This commit is contained in:
github-actions[bot]
@@ -1,5 +1,143 @@
|
||||
# @backstage/plugin-scaffolder-backend
|
||||
|
||||
## 2.0.0
|
||||
|
||||
### Major Changes
|
||||
|
||||
- 33394db: **BREAKING CHANGES**
|
||||
|
||||
Removal of deprecated re-exports from module packages.
|
||||
|
||||
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:
|
||||
|
||||
- `createPublishAzureAction` should be imported from `@backstage/plugin-scaffolder-backend-module-azure` instead.
|
||||
|
||||
- `createPublishBitbucketCloudAction` should be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket-cloud` instead.
|
||||
|
||||
- `createPublishBitbucketServerAction` and `createPublishBitbucketServerPullRequestAction` can be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket-server` instead.
|
||||
|
||||
- `createPublishBitbucketAction` should be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket` instead.
|
||||
|
||||
- `createPublishGerritAction` and `createPublishGerritReviewAction` can be imported from `@backstage/plugin-scaffolder-backend-module-gerrit` instead.
|
||||
|
||||
- `createGithubActionsDispatchAction`, `createGithubDeployKeyAction`, `createGithubEnvironmentAction`, `createGithubIssuesLabelAction`, `CreateGithubPullRequestActionOptions`, `createGithubRepoCreateAction`, `createGithubRepoPushAction`, `createGithubWebhookAction`, and `createPublishGithubAction` can be imported from `@backstage/plugin-scaffolder-backend-module-github` instead.
|
||||
|
||||
- `createPublishGitlabAction` should be imported from `@backstage/plugin-scaffolder-backend-module-gitlab` instead.
|
||||
|
||||
- `ActionContext`. `createTemplateAction`, `executeShellCommand`, `ExecuteShellCommandOptions`, `fetchContents`, `TaskSecrets`, and `TemplateAction` should be imported from `@backstage/plugin-scaffolder-node` instead.
|
||||
|
||||
- `ScaffolderEntitiesProcessor` should be imported from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead.
|
||||
|
||||
- a8fcf04: **BREAKING ALPHA**: The `/alpha` export no longer exports the plugin. Please use `import('@backstage/plugin-scaffolder-backend')` instead as this has been removed.
|
||||
|
||||
**BREAKING CHANGES**: The old `createRouter` function which was used in the old backend system has been removed along with the `RouterOptions` type.
|
||||
|
||||
- 73b94d7: **BREAKING CHANGES**
|
||||
|
||||
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:
|
||||
|
||||
- `SerializedTask`, `SerializedTaskEvent`, `TaskBroker`, `TaskBrokerDispatchOptions`, `TaskBrokerDispatchResult`, `TaskCompletionState`, `TaskContext`, `TaskEventType`, `TaskStatus`, `TemplateFilter`, and `TemplateGlobal` should be imported from `@backstage/plugin-scaffolder-node` instead.
|
||||
|
||||
- The deprecated `copyWithoutRender` option has been removed from `fetch:template` action. You should rename the option to `copyWithoutTemplating` instead.
|
||||
|
||||
- 5863b04: **BREAKING CHANGES**
|
||||
|
||||
- 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.
|
||||
|
||||
- The `createCatalogRegisterAction` and `createFetchCatalogEntityAction` actions no longer require an `AuthService`, and now accepts a `CatalogService` instead of `CatalogClient`.
|
||||
|
||||
Unless you're providing your own override action to the default, this should be a non-breaking change.
|
||||
|
||||
You can migrate using the following if you're getting typescript errors:
|
||||
|
||||
```ts
|
||||
import { catalogServiceRef } from '@backstage/plugin-catalog-node';
|
||||
import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
|
||||
|
||||
export const myModule = createBackendModule({
|
||||
pluginId: 'scaffolder',
|
||||
moduleId: 'test',
|
||||
register({ registerInit }) {
|
||||
registerInit({
|
||||
deps: {
|
||||
scaffolder: scaffolderActionsExtensionPoint,
|
||||
catalog: catalogServiceRef,
|
||||
},
|
||||
async init({ scaffolder, catalog }) {
|
||||
scaffolder.addActions(
|
||||
createCatalogRegisterAction({
|
||||
catalog,
|
||||
}),
|
||||
createFetchCatalogEntityAction({
|
||||
catalog,
|
||||
integrations,
|
||||
}),
|
||||
);
|
||||
},
|
||||
});
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 73b94d7: **DEPRECATIONS**
|
||||
|
||||
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.
|
||||
|
||||
- `CreateWorkerOptions`
|
||||
- `DatabaseTaskStore`
|
||||
- `DatabaseTaskStoreOptions`
|
||||
- `TaskManager`
|
||||
- `TaskStoreCreateTaskOptions`
|
||||
- `TaskStoreCreateTaskResult`
|
||||
- `TaskStoreEmitOptions`
|
||||
- `TaskStoreListEventsOptions`
|
||||
- `TaskStoreRecoverTaskOptions`
|
||||
- `TaskStoreShutDownTaskOptions`
|
||||
|
||||
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.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 89a941d: Migrating to latest action format
|
||||
- 023629e: Enable usage of secrets within 'each' step of software templates. For example, you can now structure your `each` step like this:
|
||||
|
||||
```
|
||||
each:
|
||||
[
|
||||
{ name: "Service1", token: "${{ secrets.token1 }}" },
|
||||
{ name: "Service2", token: "${{ secrets.token2 }}" },
|
||||
]
|
||||
```
|
||||
|
||||
- e92e481: Add tests for Scaffolder
|
||||
- Updated dependencies
|
||||
- @backstage/plugin-scaffolder-backend-module-gitlab@0.9.2
|
||||
- @backstage/plugin-scaffolder-backend-module-azure@0.2.10
|
||||
- @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.2.10
|
||||
- @backstage/plugin-scaffolder-backend-module-github@0.8.0
|
||||
- @backstage/backend-defaults@0.11.0
|
||||
- @backstage/plugin-scaffolder-node@0.9.0
|
||||
- @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.2.10
|
||||
- @backstage/plugin-scaffolder-backend-module-gerrit@0.2.10
|
||||
- @backstage/plugin-catalog-node@1.17.1
|
||||
- @backstage/plugin-auth-node@0.6.4
|
||||
- @backstage/plugin-scaffolder-backend-module-gitea@0.2.10
|
||||
- @backstage/plugin-scaffolder-backend-module-bitbucket@0.3.11
|
||||
- @backstage/backend-plugin-api@1.4.0
|
||||
- @backstage/catalog-model@1.7.4
|
||||
- @backstage/config@1.3.2
|
||||
- @backstage/errors@1.2.7
|
||||
- @backstage/integration@1.17.0
|
||||
- @backstage/types@1.2.1
|
||||
- @backstage/plugin-bitbucket-cloud-common@0.3.0
|
||||
- @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.2.9
|
||||
- @backstage/plugin-events-node@0.4.12
|
||||
- @backstage/plugin-permission-common@0.9.0
|
||||
- @backstage/plugin-permission-node@0.10.1
|
||||
- @backstage/plugin-scaffolder-common@1.5.11
|
||||
|
||||
## 2.0.0-next.2
|
||||
|
||||
### Major Changes
|
||||
|
||||
Reference in New Issue
Block a user