add deprecated changeset

Signed-off-by: Paul Cowan <paul.cowan@cutting.scot>
This commit is contained in:
Paul Cowan
2023-01-20 07:16:26 +00:00
parent 8fdc9ab3b4
commit 28ef857334
2 changed files with 24 additions and 20 deletions
+23
View File
@@ -0,0 +1,23 @@
---
'@backstage/plugin-scaffolder': minor
---
- **Deprecation** - Deprecated the following exports, please import them directly from `@backstage/plugin-scaffolder-react` instead
```
createScaffolderLayout
ScaffolderLayouts
LayoutOptions
LayoutTemplate
```
- **Deprecation** - Deprecated the `rootRouteRef` export, this should now be used from `scaffolderPlugin.routes.root`
- The following `/alpha` types have removed from this package and moved to the `@backstage/plugin-scaffolder-react/alpha` package
```
createScaffolderLayout
ScaffolderLayouts
LayoutOptions
LayoutTemplate
```
+1 -20
View File
@@ -23,26 +23,7 @@
import type { FormProps as SchemaFormProps } from '@rjsf/core-v5';
/**
* The field template from `@rjsf/core` which is a react component that gets passed `@rjsf/core` field related props.
*
* @alpha
*/
export type NextLayoutTemplate<T = any> = NonNullable<
SchemaFormProps<T>['uiSchema']
>['ui:ObjectFieldTemplate'];
/**
* The type of layouts that is passed to the TemplateForms
*
* @alpha
*/
export interface NextLayoutOptions<P = any> {
name: string;
component: NextLayoutTemplate<P>;
}
/**
* Any `@rjsf/core` form properties that are publicly exposed to the `NextScaffolderpage`
* Any `@rjsf/core` form properties that are publicly exposed to the `NextScaffolderPage`
*
* @alpha
* @deprecated use the import from {@link @backstage/plugin-scaffolder-react/alpha#FormProps} instead