From 1806e0c26e3e84209d189ff0b96e0cf61dbd8bcd Mon Sep 17 00:00:00 2001
From: blam <ben@blam.sh>
Date: Tue, 10 Jan 2023 12:15:06 +0100
Subject: [PATCH] chore: deprecate the routeRef export and favour routes.root
 instead

Signed-off-by: blam <ben@blam.sh>
---
 plugins/scaffolder/api-report.md     | 2 +-
 plugins/scaffolder/src/deprecated.ts | 2 +-
 plugins/scaffolder/src/index.ts      | 1 -
 plugins/scaffolder/src/plugin.tsx    | 1 +
 4 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md
index 3706d869cd..dcfa78b4ee 100644
--- a/plugins/scaffolder/api-report.md
+++ b/plugins/scaffolder/api-report.md
@@ -348,7 +348,7 @@ export type ReviewStepProps = {
   }[];
 };
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const rootRouteRef: RouteRef<undefined>;
 
 // @public
diff --git a/plugins/scaffolder/src/deprecated.ts b/plugins/scaffolder/src/deprecated.ts
index 72243641ed..201f7ac7d7 100644
--- a/plugins/scaffolder/src/deprecated.ts
+++ b/plugins/scaffolder/src/deprecated.ts
@@ -52,7 +52,7 @@ import { rootRouteRef as rootRouteRefTemp } from './routes';
 
 /**
  * @public
- * @deprecated use import from {@link @backstage/plugin-scaffolder#plugin.routes.root} instead.
+ * @deprecated use import from `{@link @backstage/plugin-scaffolder#scaffolderPlugin}.routes.root` instead.
  */
 export const rootRouteRef = rootRouteRefTemp;
 /**
diff --git a/plugins/scaffolder/src/index.ts b/plugins/scaffolder/src/index.ts
index 5f165111af..b4e1bd99d4 100644
--- a/plugins/scaffolder/src/index.ts
+++ b/plugins/scaffolder/src/index.ts
@@ -42,7 +42,6 @@ export {
 } from './plugin';
 
 export * from './components';
-export { rootRouteRef } from './routes';
 export * from './deprecated';
 
 /** next exports */
diff --git a/plugins/scaffolder/src/plugin.tsx b/plugins/scaffolder/src/plugin.tsx
index 828bb6e25c..3d8ad5dd29 100644
--- a/plugins/scaffolder/src/plugin.tsx
+++ b/plugins/scaffolder/src/plugin.tsx
@@ -95,6 +95,7 @@ export const scaffolderPlugin = createPlugin({
     root: rootRouteRef,
     selectedTemplate: selectedTemplateRouteRef,
     ongoingTask: scaffolderTaskRouteRef,
+
     /** next routes */
     next: nextRouteRef,
     nextSelectedTemplate: nextSelectedTemplateRouteRef,