From 3b51b81408c7f24882f769c38090bfc820a5ba46 Mon Sep 17 00:00:00 2001 From: Chris James Date: Tue, 11 Jul 2023 13:29:25 -0700 Subject: [PATCH 1/4] Fix typo for UnprocessedEntitiesModule Signed-off-by: Chris James --- packages/backend/src/plugins/catalog.ts | 4 ++-- plugins/catalog-backend-module-unprocessed/README.md | 4 ++-- plugins/catalog-backend-module-unprocessed/api-report.md | 2 +- .../src/UnprocessedEntitiesModule.ts | 2 +- plugins/catalog-backend-module-unprocessed/src/module.ts | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/backend/src/plugins/catalog.ts b/packages/backend/src/plugins/catalog.ts index a0fd21b4d8..7afd0a0cb7 100644 --- a/packages/backend/src/plugins/catalog.ts +++ b/packages/backend/src/plugins/catalog.ts @@ -19,7 +19,7 @@ import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backen import { Router } from 'express'; import { PluginEnvironment } from '../types'; import { DemoEventBasedEntityProvider } from './DemoEventBasedEntityProvider'; -import { UnprocessedEntitesModule } from '@backstage/plugin-catalog-backend-module-unprocessed'; +import { UnprocessedEntitiesModule } from '@backstage/plugin-catalog-backend-module-unprocessed'; export default async function createPlugin( env: PluginEnvironment, @@ -36,7 +36,7 @@ export default async function createPlugin( const { processingEngine, router } = await builder.build(); - const unprocessed = new UnprocessedEntitesModule( + const unprocessed = new UnprocessedEntitiesModule( await env.database.getClient(), router, ); diff --git a/plugins/catalog-backend-module-unprocessed/README.md b/plugins/catalog-backend-module-unprocessed/README.md index 92d9e59445..f2ea7b7741 100644 --- a/plugins/catalog-backend-module-unprocessed/README.md +++ b/plugins/catalog-backend-module-unprocessed/README.md @@ -19,11 +19,11 @@ yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-unproce In `packages/backend/src/plugins/catalog.ts` import the module and initialize it after invoking `CatalogBuilder.build()`: ```ts title="packages/backend/src/plugins/catalog.ts" -import { UnprocessedEntitesModule } from '@backstage/plugin-catalog-backend-module-unprocessed'; +import { UnprocessedEntitiesModule } from '@backstage/plugin-catalog-backend-module-unprocessed'; //... -const unprocessed = new UnprocessedEntitesModule( +const unprocessed = new UnprocessedEntitiesModule( await env.database.getClient(), router, ); diff --git a/plugins/catalog-backend-module-unprocessed/api-report.md b/plugins/catalog-backend-module-unprocessed/api-report.md index 3fc81c62cc..7fd7119276 100644 --- a/plugins/catalog-backend-module-unprocessed/api-report.md +++ b/plugins/catalog-backend-module-unprocessed/api-report.md @@ -11,7 +11,7 @@ import { Knex } from 'knex'; export const catalogModuleUnprocessedEntities: () => BackendFeature; // @public -export class UnprocessedEntitesModule { +export class UnprocessedEntitiesModule { constructor(database: Knex, router: HttpRouterService); // (undocumented) registerRoutes(): void; diff --git a/plugins/catalog-backend-module-unprocessed/src/UnprocessedEntitiesModule.ts b/plugins/catalog-backend-module-unprocessed/src/UnprocessedEntitiesModule.ts index 6ea184ce83..bdd3f64488 100644 --- a/plugins/catalog-backend-module-unprocessed/src/UnprocessedEntitiesModule.ts +++ b/plugins/catalog-backend-module-unprocessed/src/UnprocessedEntitiesModule.ts @@ -30,7 +30,7 @@ import { getBearerTokenFromAuthorizationHeader } from '@backstage/plugin-auth-no * * @public */ -export class UnprocessedEntitesModule { +export class UnprocessedEntitiesModule { private readonly moduleRouter; constructor( diff --git a/plugins/catalog-backend-module-unprocessed/src/module.ts b/plugins/catalog-backend-module-unprocessed/src/module.ts index 1c4b6c658f..1db4fd70b0 100644 --- a/plugins/catalog-backend-module-unprocessed/src/module.ts +++ b/plugins/catalog-backend-module-unprocessed/src/module.ts @@ -18,7 +18,7 @@ import { coreServices, createBackendModule, } from '@backstage/backend-plugin-api'; -import { UnprocessedEntitesModule } from './UnprocessedEntitiesModule'; +import { UnprocessedEntitiesModule } from './UnprocessedEntitiesModule'; /** * Catalog Module for Unprocessed Entities @@ -36,7 +36,7 @@ export const catalogModuleUnprocessedEntities = createBackendModule({ logger: coreServices.logger, }, async init({ database, router, logger }) { - const module = new UnprocessedEntitesModule( + const module = new UnprocessedEntitiesModule( await database.getClient(), router, ); From 5156a94c2e2a8f078fef9104370cd1ae64beecd3 Mon Sep 17 00:00:00 2001 From: Chris James Date: Wed, 12 Jul 2023 11:15:39 -0700 Subject: [PATCH 2/4] add changeset for typo Signed-off-by: Chris James --- .changeset/pink-squids-nail.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/pink-squids-nail.md diff --git a/.changeset/pink-squids-nail.md b/.changeset/pink-squids-nail.md new file mode 100644 index 0000000000..6645dfe2bf --- /dev/null +++ b/.changeset/pink-squids-nail.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-catalog-backend-module-unprocessed': minor +'example-backend': minor +--- + +Fix typo of UnprocessedEntitiesModule. From 734cca679014cf70bc11ac47d4cfe0373b744c4d Mon Sep 17 00:00:00 2001 From: Chris James Date: Wed, 12 Jul 2023 11:23:01 -0700 Subject: [PATCH 3/4] Update pink-squids-nail.md Signed-off-by: Chris James --- .changeset/pink-squids-nail.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.changeset/pink-squids-nail.md b/.changeset/pink-squids-nail.md index 6645dfe2bf..ed95f3171a 100644 --- a/.changeset/pink-squids-nail.md +++ b/.changeset/pink-squids-nail.md @@ -1,6 +1,5 @@ --- '@backstage/plugin-catalog-backend-module-unprocessed': minor -'example-backend': minor --- Fix typo of UnprocessedEntitiesModule. From 1f54aca5da22de6ffa95df76d76bcafef0bfab24 Mon Sep 17 00:00:00 2001 From: Ben Lambert Date: Thu, 20 Jul 2023 12:02:15 +0200 Subject: [PATCH 4/4] Update pink-squids-nail.md Signed-off-by: Ben Lambert --- .changeset/pink-squids-nail.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/pink-squids-nail.md b/.changeset/pink-squids-nail.md index ed95f3171a..989b5034d5 100644 --- a/.changeset/pink-squids-nail.md +++ b/.changeset/pink-squids-nail.md @@ -2,4 +2,4 @@ '@backstage/plugin-catalog-backend-module-unprocessed': minor --- -Fix typo of UnprocessedEntitiesModule. +**BREAKING**: Fixing typo in exported module. You will have to rename the import to the correct spelling. `UnprocessedEntites` -> `UnprocessedEntities`