From 1c6825d88aa6262d1bddc6a1ce0c9839da9b3cf1 Mon Sep 17 00:00:00 2001 From: Kiss Miklos Date: Thu, 10 Feb 2022 16:12:13 +0100 Subject: [PATCH 1/4] add missing step to docs Signed-off-by: Kiss Miklos --- .../migrating-from-v1beta2-to-v1beta3.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md index 4cc9a6a8e6..4c52462aa6 100644 --- a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md +++ b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md @@ -33,7 +33,17 @@ We've also removed a lot of the built in helpers that we shipped with The migration path is pretty simple, and we've removed some of the pain points from writing the `handlebars` templates too. Let's go through what's new and how to upgrade. +## Add processor +An important change is to add the required processor to your `packages/backend/src/plugins/catalog.ts` +```diff ++import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend'; +... + + const builder = await CatalogBuilder.create(env); ++ builder.addProcessor(new ScaffolderEntitiesProcessor()); + const { processingEngine, router } = await builder.build(); +``` ## `backstage.io/v1beta2` -> `scaffolder.backstage.io/v1beta3` The most important change is that you'll need to switch over the `apiVersion` in @@ -45,6 +55,7 @@ your templates to the new one. + apiVersion: scaffolder.backstage.io/v1beta3 ``` + ## `${{ }}` instead of `"{{ }}"` One really big readability issue and cause for confusion was the fact that with From 4a3386a35cd4c5c4dcaa018ff326c32b58ba5d60 Mon Sep 17 00:00:00 2001 From: Kiss Miklos Date: Thu, 10 Feb 2022 16:17:38 +0100 Subject: [PATCH 2/4] remove accidental change Signed-off-by: Kiss Miklos --- .../software-templates/migrating-from-v1beta2-to-v1beta3.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md index 4c52462aa6..5196992617 100644 --- a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md +++ b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md @@ -55,7 +55,6 @@ your templates to the new one. + apiVersion: scaffolder.backstage.io/v1beta3 ``` - ## `${{ }}` instead of `"{{ }}"` One really big readability issue and cause for confusion was the fact that with From 17240b1c1773ebe3b8334cf83bce729156ab7c3e Mon Sep 17 00:00:00 2001 From: Kiss Miklos Date: Thu, 10 Feb 2022 16:52:50 +0100 Subject: [PATCH 3/4] run prettier on changed file Signed-off-by: Kiss Miklos --- .../software-templates/migrating-from-v1beta2-to-v1beta3.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md index 5196992617..7d0fcfaf20 100644 --- a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md +++ b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md @@ -33,8 +33,11 @@ We've also removed a lot of the built in helpers that we shipped with The migration path is pretty simple, and we've removed some of the pain points from writing the `handlebars` templates too. Let's go through what's new and how to upgrade. + ## Add processor + An important change is to add the required processor to your `packages/backend/src/plugins/catalog.ts` + ```diff +import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend'; @@ -44,6 +47,7 @@ An important change is to add the required processor to your `packages/backend/s + builder.addProcessor(new ScaffolderEntitiesProcessor()); const { processingEngine, router } = await builder.build(); ``` + ## `backstage.io/v1beta2` -> `scaffolder.backstage.io/v1beta3` The most important change is that you'll need to switch over the `apiVersion` in From 4610dab4532a318a66f1f355138395b0da6e2e5b Mon Sep 17 00:00:00 2001 From: Kiss Miklos Date: Thu, 10 Feb 2022 17:08:15 +0100 Subject: [PATCH 4/4] Make header more readable Signed-off-by: Kiss Miklos --- .../software-templates/migrating-from-v1beta2-to-v1beta3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md index 7d0fcfaf20..559cb036e0 100644 --- a/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md +++ b/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3.md @@ -34,7 +34,7 @@ The migration path is pretty simple, and we've removed some of the pain points from writing the `handlebars` templates too. Let's go through what's new and how to upgrade. -## Add processor +## Add the Processor to the `plugin-catalog-backend` An important change is to add the required processor to your `packages/backend/src/plugins/catalog.ts`