Skip to content

Commit

Permalink
docs: fix instructions for backend migration
Browse files Browse the repository at this point in the history
Signed-off-by: Tiago Barbosa <[email protected]>
  • Loading branch information
t1agob committed Apr 15, 2024
1 parent 457885e commit 7166943
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/migration/backend-system-migration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Migrate to Backstage's new backend system

Version 0.0.6 of `@pagerduty/backstage-plugin-backend` introduced support for Backstage's new backend system while remaining backwards compatible. So, if you want to continue using the legacy backend system you can do so. There's no rush!
Version 0.6.0 of `@pagerduty/backstage-plugin-backend` introduced support for Backstage's new backend system while remaining backwards compatible. So, if you want to continue using the legacy backend system you can do so. There's no rush!

Still, a couple things changed. Due to an architecture change on the new backend system we add to extract the scaffolder actions to a new Backstage module ([@pagerduty/backstage-plugin-scaffolder-actions](https://www.npmjs.com/package/@pagerduty/backstage-plugin-scaffolder-actions)).

Expand All @@ -13,6 +13,7 @@ If you choose to upgrade to `@pagerduty/backstage-plugin-backend` 0.6.0 and stil
1. Add and install the new package

```bash
yarn add --cwd packages/backend @pagerduty/backstage-plugin-backend # or upgrade to 0.6.0
yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
yarn install
```
Expand All @@ -30,13 +31,15 @@ The new backend system reduces drastically the amount of code needed to setup pl
1. Add and install the new package
```bash
yarn add --cwd packages/backend @pagerduty/backstage-plugin-backend # or upgrade to 0.6.0
yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
yarn install
```
2. Add backend middleware in `packages/backend/src/index.ts`
```typescript
backend.add(import('@pagerduty/backstage-plugin-backend'));
backend.add(import('@pagerduty/backstage-plugin-scaffolder-actions'));
```
Expand Down

0 comments on commit 7166943

Please sign in to comment.