diff --git a/.changeset/sixty-islands-develop.md b/.changeset/sixty-islands-develop.md index 75af6bcc70..1afcc5730a 100644 --- a/.changeset/sixty-islands-develop.md +++ b/.changeset/sixty-islands-develop.md @@ -2,4 +2,4 @@ '@backstage/plugin-scaffolder': patch --- -Added props to override default Scaffolder page title, subtitle and pageTitleOverride +Added props to override default Scaffolder page title, subtitle and pageTitleOverride. diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index 5931e127f5..e759049233 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -44,9 +44,6 @@ export function createNextScaffolderFieldExtension< options: NextFieldExtensionOptions, ): Extension>; -// @public (undocumented) -export const actionsRouteRef: SubRouteRef; - // @public export function createScaffolderFieldExtension< TReturnValue = unknown, @@ -69,9 +66,6 @@ export type CustomFieldValidator = ( }, ) => void | Promise; -// @public (undocumented) -export const editRouteRef: SubRouteRef; - // @public export const EntityNamePickerFieldExtension: FieldExtensionComponent< string, @@ -152,11 +146,6 @@ export interface LayoutOptions

{ // @public export type LayoutTemplate = FormProps['ObjectFieldTemplate']; -// @public (undocumented) -export const legacySelectedTemplateRouteRef: SubRouteRef< - PathParams<'/templates/:templateName'> ->; - // @public export type ListActionsResponse = Array<{ id: string; @@ -180,7 +169,7 @@ export type LogEvent = { taskId: string; }; -// @public (undocumented) +// @alpha (undocumented) export const nextRouteRef: RouteRef; // @alpha @@ -231,7 +220,7 @@ export const NextScaffolderPage: ( props: PropsWithChildren, ) => JSX.Element; -// @public (undocumented) +// @alpha (undocumented) export const nextSelectedTemplateRouteRef: SubRouteRef< PathParams<'/templates/:namespace/:templateName'> >; @@ -270,9 +259,6 @@ export interface OwnerPickerUiOptions { defaultNamespace?: string | false; } -// @public (undocumented) -export const registerComponentRouteRef: ExternalRouteRef; - // @public export const repoPickerValidation: ( value: string, @@ -456,9 +442,6 @@ export interface ScaffolderGetIntegrationsListResponse { // @public export const ScaffolderLayouts: React.ComponentType; -// @public (undocumented) -export const scaffolderListTaskRouteRef: SubRouteRef; - // @public (undocumented) export type ScaffolderOutputLink = { title?: string; @@ -529,9 +512,6 @@ export type ScaffolderTaskOutput = { [key: string]: unknown; }; -// @public (undocumented) -export const scaffolderTaskRouteRef: SubRouteRef>; - // @public export type ScaffolderTaskStatus = | 'open' @@ -581,14 +561,4 @@ export const TemplateTypePicker: () => JSX.Element | null; // @public export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets; - -// @public (undocumented) -export const viewTechDocRouteRef: ExternalRouteRef< - { - name: string; - kind: string; - namespace: string; - }, - true ->; ``` diff --git a/plugins/scaffolder/src/index.ts b/plugins/scaffolder/src/index.ts index 440c87c363..7853667101 100644 --- a/plugins/scaffolder/src/index.ts +++ b/plugins/scaffolder/src/index.ts @@ -61,7 +61,12 @@ export { scaffolderPlugin, } from './plugin'; export * from './components'; -export * from './routes'; +export { + rootRouteRef, + nextRouteRef, + selectedTemplateRouteRef, + nextSelectedTemplateRouteRef, +} from './routes'; export type { TaskPageProps } from './components/TaskPage'; /** next exports */ diff --git a/plugins/scaffolder/src/routes.ts b/plugins/scaffolder/src/routes.ts index 26e25b54a2..7451a3a943 100644 --- a/plugins/scaffolder/src/routes.ts +++ b/plugins/scaffolder/src/routes.ts @@ -19,13 +19,11 @@ import { createSubRouteRef, } from '@backstage/core-plugin-api'; -/** @public */ export const registerComponentRouteRef = createExternalRouteRef({ id: 'register-component', optional: true, }); -/** @public */ export const viewTechDocRouteRef = createExternalRouteRef({ id: 'view-techdoc', optional: true, @@ -40,14 +38,13 @@ export const rootRouteRef = createRouteRef({ /** * @deprecated This is the old template route, can be deleted before next major release */ -/** @public */ export const legacySelectedTemplateRouteRef = createSubRouteRef({ id: 'scaffolder/legacy/selected-template', parent: rootRouteRef, path: '/templates/:templateName', }); -/** @public */ +/** @alpha */ export const nextRouteRef = createRouteRef({ id: 'scaffolder/next', }); @@ -59,14 +56,13 @@ export const selectedTemplateRouteRef = createSubRouteRef({ path: '/templates/:namespace/:templateName', }); -/** @public */ +/** @alpha */ export const nextSelectedTemplateRouteRef = createSubRouteRef({ id: 'scaffolder/next/selected-template', parent: nextRouteRef, path: '/templates/:namespace/:templateName', }); -/** @public */ export const scaffolderTaskRouteRef = createSubRouteRef({ id: 'scaffolder/task', parent: rootRouteRef, @@ -79,21 +75,18 @@ export const nextScaffolderTaskRouteRef = createSubRouteRef({ path: '/tasks/:taskId', }); -/** @public */ export const scaffolderListTaskRouteRef = createSubRouteRef({ id: 'scaffolder/list-tasks', parent: rootRouteRef, path: '/tasks', }); -/** @public */ export const actionsRouteRef = createSubRouteRef({ id: 'scaffolder/actions', parent: rootRouteRef, path: '/actions', }); -/** @public */ export const editRouteRef = createSubRouteRef({ id: 'scaffolder/edit', parent: rootRouteRef,