diff --git a/.changeset/twenty-worms-enjoy.md b/.changeset/twenty-worms-enjoy.md index a84246bad9..ef820a3c9e 100644 --- a/.changeset/twenty-worms-enjoy.md +++ b/.changeset/twenty-worms-enjoy.md @@ -2,6 +2,6 @@ '@backstage/plugin-scaffolder-backend': minor --- -**DEPRECATION**: Deprecated `ScaffolderEntitiesProcessor`, which should now instead be imported from `@backstage/plugin-catalog-backend-module-scaffolder-entities`. +**DEPRECATION**: Deprecated `ScaffolderEntitiesProcessor`, which should now instead be imported from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model`. -`catalogModuleTemplateKind` was also moved to that package, without any deprecation since it was an alpha export. +`catalogModuleTemplateKind` was also moved to that package and renamed to `catalogModuleScaffolderEntityModel`, without any deprecation since it was an alpha export. diff --git a/.changeset/wet-donuts-fry.md b/.changeset/wet-donuts-fry.md index 95555e726f..1f4c8dc4fc 100644 --- a/.changeset/wet-donuts-fry.md +++ b/.changeset/wet-donuts-fry.md @@ -1,5 +1,5 @@ --- -'@backstage/plugin-catalog-backend-module-scaffolder-entities': minor +'@backstage/plugin-catalog-backend-module-scaffolder-entity-model': minor --- Added a dedicated module to collect the `ScaffolderEntitiesProcessor` and `catalogModuleTemplateKind`. diff --git a/docs/features/software-catalog/extending-the-model.md b/docs/features/software-catalog/extending-the-model.md index 27fca6b5e8..52ef565837 100644 --- a/docs/features/software-catalog/extending-the-model.md +++ b/docs/features/software-catalog/extending-the-model.md @@ -467,7 +467,7 @@ The next step is to create a custom processor for your new entity kind. This will be used within the catalog to make sure that it's able to ingest and validate entities of our new kind. Just like with the definition package, you can find inspiration in for example the existing -[ScaffolderEntitiesProcessor](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend-module-scaffolder-entities/src/processor/ScaffolderEntitiesProcessor.ts). +[ScaffolderEntitiesProcessor](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend-module-scaffolder-entity-model/src/processor/ScaffolderEntitiesProcessor.ts). We also provide a high-level example of what a catalog process for a custom entity might look like: diff --git a/packages/backend-next/package.json b/packages/backend-next/package.json index 203ee88dc5..2d5be63261 100644 --- a/packages/backend-next/package.json +++ b/packages/backend-next/package.json @@ -34,7 +34,7 @@ "@backstage/plugin-azure-devops-backend": "workspace:^", "@backstage/plugin-badges-backend": "workspace:^", "@backstage/plugin-catalog-backend": "workspace:^", - "@backstage/plugin-catalog-backend-module-scaffolder-entities": "workspace:^", + "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "workspace:^", "@backstage/plugin-catalog-backend-module-unprocessed": "workspace:^", "@backstage/plugin-devtools-backend": "workspace:^", "@backstage/plugin-entity-feedback-backend": "workspace:^", diff --git a/packages/backend-next/src/index.ts b/packages/backend-next/src/index.ts index fd648f7ad0..4e99732a11 100644 --- a/packages/backend-next/src/index.ts +++ b/packages/backend-next/src/index.ts @@ -24,7 +24,7 @@ backend.add(import('@backstage/plugin-azure-devops-backend')); backend.add(import('@backstage/plugin-badges-backend')); backend.add(import('@backstage/plugin-catalog-backend-module-unprocessed')); backend.add( - import('@backstage/plugin-catalog-backend-module-scaffolder-entities'), + import('@backstage/plugin-catalog-backend-module-scaffolder-entity-model'), ); backend.add(import('@backstage/plugin-catalog-backend/alpha')); backend.add(import('@backstage/plugin-devtools-backend')); diff --git a/packages/backend/package.json b/packages/backend/package.json index 5de5843218..7872ada1aa 100644 --- a/packages/backend/package.json +++ b/packages/backend/package.json @@ -40,7 +40,7 @@ "@backstage/plugin-azure-sites-backend": "workspace:^", "@backstage/plugin-badges-backend": "workspace:^", "@backstage/plugin-catalog-backend": "workspace:^", - "@backstage/plugin-catalog-backend-module-scaffolder-entities": "workspace:^", + "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "workspace:^", "@backstage/plugin-catalog-backend-module-unprocessed": "workspace:^", "@backstage/plugin-catalog-node": "workspace:^", "@backstage/plugin-code-coverage-backend": "workspace:^", diff --git a/packages/backend/src/plugins/catalog.ts b/packages/backend/src/plugins/catalog.ts index 72e64abf55..223acab818 100644 --- a/packages/backend/src/plugins/catalog.ts +++ b/packages/backend/src/plugins/catalog.ts @@ -15,7 +15,7 @@ */ import { CatalogBuilder } from '@backstage/plugin-catalog-backend'; -import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entities'; +import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model'; import { UnprocessedEntitiesModule } from '@backstage/plugin-catalog-backend-module-unprocessed'; import { Router } from 'express'; import { PluginEnvironment } from '../types'; diff --git a/plugins/catalog-backend-module-scaffolder-entities/README.md b/plugins/catalog-backend-module-scaffolder-entities/README.md deleted file mode 100644 index fa7612d55a..0000000000 --- a/plugins/catalog-backend-module-scaffolder-entities/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# @backstage/plugin-catalog-backend-module-scaffolder-entities - -The scaffolder-entities backend module for the catalog plugin. - -_This plugin was created through the Backstage CLI_ diff --git a/plugins/catalog-backend-module-scaffolder-entities/.eslintrc.js b/plugins/catalog-backend-module-scaffolder-entity-model/.eslintrc.js similarity index 100% rename from plugins/catalog-backend-module-scaffolder-entities/.eslintrc.js rename to plugins/catalog-backend-module-scaffolder-entity-model/.eslintrc.js diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/README.md b/plugins/catalog-backend-module-scaffolder-entity-model/README.md new file mode 100644 index 0000000000..c7535df66d --- /dev/null +++ b/plugins/catalog-backend-module-scaffolder-entity-model/README.md @@ -0,0 +1,3 @@ +# @backstage/plugin-catalog-backend-module-scaffolder-entity-model + +Adds support for the scaffolder specific entity model (e.g. the Template kind) to the catalog backend plugin. diff --git a/plugins/catalog-backend-module-scaffolder-entities/api-report.md b/plugins/catalog-backend-module-scaffolder-entity-model/api-report.md similarity index 85% rename from plugins/catalog-backend-module-scaffolder-entities/api-report.md rename to plugins/catalog-backend-module-scaffolder-entity-model/api-report.md index 462788ebcd..f9861959b7 100644 --- a/plugins/catalog-backend-module-scaffolder-entities/api-report.md +++ b/plugins/catalog-backend-module-scaffolder-entity-model/api-report.md @@ -1,4 +1,4 @@ -## API Report File for "@backstage/plugin-catalog-backend-module-scaffolder-entities" +## API Report File for "@backstage/plugin-catalog-backend-module-scaffolder-entity-model" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). @@ -10,8 +10,8 @@ import { Entity } from '@backstage/catalog-model'; import { LocationSpec } from '@backstage/plugin-catalog-common'; // @public -const catalogModuleTemplateKind: () => BackendFeature; -export default catalogModuleTemplateKind; +const catalogModuleScaffolderEntityModel: () => BackendFeature; +export default catalogModuleScaffolderEntityModel; // @public export class ScaffolderEntitiesProcessor implements CatalogProcessor { diff --git a/plugins/catalog-backend-module-scaffolder-entities/package.json b/plugins/catalog-backend-module-scaffolder-entity-model/package.json similarity index 89% rename from plugins/catalog-backend-module-scaffolder-entities/package.json rename to plugins/catalog-backend-module-scaffolder-entity-model/package.json index 199c2fb57e..9d8ab167a5 100644 --- a/plugins/catalog-backend-module-scaffolder-entities/package.json +++ b/plugins/catalog-backend-module-scaffolder-entity-model/package.json @@ -1,6 +1,6 @@ { - "name": "@backstage/plugin-catalog-backend-module-scaffolder-entities", - "description": "The scaffolder-entities backend module for the catalog plugin", + "name": "@backstage/plugin-catalog-backend-module-scaffolder-entity-model", + "description": "Adds support for the scaffolder specific entity model (e.g. the Template kind) to the catalog backend plugin.", "version": "0.0.0", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog-backend-module-scaffolder-entities/src/index.ts b/plugins/catalog-backend-module-scaffolder-entity-model/src/index.ts similarity index 78% rename from plugins/catalog-backend-module-scaffolder-entities/src/index.ts rename to plugins/catalog-backend-module-scaffolder-entity-model/src/index.ts index feeb9af444..b2cd6eadde 100644 --- a/plugins/catalog-backend-module-scaffolder-entities/src/index.ts +++ b/plugins/catalog-backend-module-scaffolder-entity-model/src/index.ts @@ -15,10 +15,10 @@ */ /** - * The scaffolder-entities backend module for the catalog plugin. + * Adds support for the scaffolder specific entity model (e.g. the Template kind) to the catalog backend plugin. * * @packageDocumentation */ export * from './processor'; -export { catalogModuleTemplateKind as default } from './module'; +export { catalogModuleScaffolderEntityModel as default } from './module'; diff --git a/plugins/catalog-backend-module-scaffolder-entities/src/module.test.ts b/plugins/catalog-backend-module-scaffolder-entity-model/src/module.test.ts similarity index 87% rename from plugins/catalog-backend-module-scaffolder-entities/src/module.test.ts rename to plugins/catalog-backend-module-scaffolder-entity-model/src/module.test.ts index 8227f1f2e0..f9111c1be5 100644 --- a/plugins/catalog-backend-module-scaffolder-entities/src/module.test.ts +++ b/plugins/catalog-backend-module-scaffolder-entity-model/src/module.test.ts @@ -16,15 +16,15 @@ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; import { ScaffolderEntitiesProcessor } from './processor'; -import { catalogModuleTemplateKind } from './module'; +import { catalogModuleScaffolderEntityModel } from './module'; import { startTestBackend } from '@backstage/backend-test-utils'; -describe('catalogModuleTemplateKind', () => { +describe('catalogModuleScaffolderEntityModel', () => { it('should register the extension point', async () => { const extensionPoint = { addProcessor: jest.fn() }; await startTestBackend({ extensionPoints: [[catalogProcessingExtensionPoint, extensionPoint]], - features: [catalogModuleTemplateKind()], + features: [catalogModuleScaffolderEntityModel()], }); expect(extensionPoint.addProcessor).toHaveBeenCalledWith( diff --git a/plugins/catalog-backend-module-scaffolder-entities/src/module.ts b/plugins/catalog-backend-module-scaffolder-entity-model/src/module.ts similarity index 79% rename from plugins/catalog-backend-module-scaffolder-entities/src/module.ts rename to plugins/catalog-backend-module-scaffolder-entity-model/src/module.ts index 4a0bd5046e..8ed763d32c 100644 --- a/plugins/catalog-backend-module-scaffolder-entities/src/module.ts +++ b/plugins/catalog-backend-module-scaffolder-entity-model/src/module.ts @@ -16,16 +16,17 @@ import { createBackendModule } from '@backstage/backend-plugin-api'; import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha'; -import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entities'; +import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model'; /** - * Registers support for the Template kind to the catalog backend plugin. + * Registers support for the scaffolder specific entity model (e.g. the Template + * kind) to the catalog backend plugin. * * @public */ -export const catalogModuleTemplateKind = createBackendModule({ +export const catalogModuleScaffolderEntityModel = createBackendModule({ pluginId: 'catalog', - moduleId: 'templateKind', + moduleId: 'scaffolderEntityModel', register(env) { env.registerInit({ deps: { diff --git a/plugins/catalog-backend-module-scaffolder-entities/src/processor/ScaffolderEntitiesProcessor.test.ts b/plugins/catalog-backend-module-scaffolder-entity-model/src/processor/ScaffolderEntitiesProcessor.test.ts similarity index 100% rename from plugins/catalog-backend-module-scaffolder-entities/src/processor/ScaffolderEntitiesProcessor.test.ts rename to plugins/catalog-backend-module-scaffolder-entity-model/src/processor/ScaffolderEntitiesProcessor.test.ts diff --git a/plugins/catalog-backend-module-scaffolder-entities/src/processor/ScaffolderEntitiesProcessor.ts b/plugins/catalog-backend-module-scaffolder-entity-model/src/processor/ScaffolderEntitiesProcessor.ts similarity index 100% rename from plugins/catalog-backend-module-scaffolder-entities/src/processor/ScaffolderEntitiesProcessor.ts rename to plugins/catalog-backend-module-scaffolder-entity-model/src/processor/ScaffolderEntitiesProcessor.ts diff --git a/plugins/catalog-backend-module-scaffolder-entities/src/processor/index.ts b/plugins/catalog-backend-module-scaffolder-entity-model/src/processor/index.ts similarity index 100% rename from plugins/catalog-backend-module-scaffolder-entities/src/processor/index.ts rename to plugins/catalog-backend-module-scaffolder-entity-model/src/processor/index.ts diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index d59bdbf2a4..17e13131cf 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -26,7 +26,7 @@ import { PluginDatabaseManager } from '@backstage/backend-common'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; import { RESOURCE_TYPE_SCAFFOLDER_ACTION } from '@backstage/plugin-scaffolder-common/alpha'; import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha'; -import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessor_2 } from '@backstage/plugin-catalog-backend-module-scaffolder-entities'; +import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessor_2 } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model'; import { Schema } from 'jsonschema'; import { ScmIntegrationRegistry } from '@backstage/integration'; import { ScmIntegrations } from '@backstage/integration'; diff --git a/plugins/scaffolder-backend/package.json b/plugins/scaffolder-backend/package.json index 7f006339d4..781bf1b572 100644 --- a/plugins/scaffolder-backend/package.json +++ b/plugins/scaffolder-backend/package.json @@ -56,7 +56,7 @@ "@backstage/integration": "workspace:^", "@backstage/plugin-auth-node": "workspace:^", "@backstage/plugin-catalog-backend": "workspace:^", - "@backstage/plugin-catalog-backend-module-scaffolder-entities": "workspace:^", + "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "workspace:^", "@backstage/plugin-catalog-common": "workspace:^", "@backstage/plugin-catalog-node": "workspace:^", "@backstage/plugin-permission-common": "workspace:^", diff --git a/plugins/scaffolder-backend/src/deprecated.ts b/plugins/scaffolder-backend/src/deprecated.ts index a17ce521f2..a1bcc30564 100644 --- a/plugins/scaffolder-backend/src/deprecated.ts +++ b/plugins/scaffolder-backend/src/deprecated.ts @@ -24,7 +24,7 @@ import { fetchContents as fetchContentsNode, } from '@backstage/plugin-scaffolder-node'; import { JsonObject } from '@backstage/types'; -import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessorModule } from '@backstage/plugin-catalog-backend-module-scaffolder-entities'; +import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessorModule } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model'; /** * @public @@ -81,6 +81,6 @@ export const fetchContents = fetchContentsNode; * Adds support for scaffolder specific entity kinds to the catalog. * * @public - * @deprecated Import from `@backstage/plugin-catalog-backend-module-scaffolder-entities` instead + * @deprecated Import from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead */ export const ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessorModule; diff --git a/yarn.lock b/yarn.lock index 6745a0b96f..454aba2bd4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5667,9 +5667,9 @@ __metadata: languageName: unknown linkType: soft -"@backstage/plugin-catalog-backend-module-scaffolder-entities@workspace:^, @backstage/plugin-catalog-backend-module-scaffolder-entities@workspace:plugins/catalog-backend-module-scaffolder-entities": +"@backstage/plugin-catalog-backend-module-scaffolder-entity-model@workspace:^, @backstage/plugin-catalog-backend-module-scaffolder-entity-model@workspace:plugins/catalog-backend-module-scaffolder-entity-model": version: 0.0.0-use.local - resolution: "@backstage/plugin-catalog-backend-module-scaffolder-entities@workspace:plugins/catalog-backend-module-scaffolder-entities" + resolution: "@backstage/plugin-catalog-backend-module-scaffolder-entity-model@workspace:plugins/catalog-backend-module-scaffolder-entity-model" dependencies: "@backstage/backend-common": "workspace:^" "@backstage/backend-plugin-api": "workspace:^" @@ -8652,7 +8652,7 @@ __metadata: "@backstage/integration": "workspace:^" "@backstage/plugin-auth-node": "workspace:^" "@backstage/plugin-catalog-backend": "workspace:^" - "@backstage/plugin-catalog-backend-module-scaffolder-entities": "workspace:^" + "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "workspace:^" "@backstage/plugin-catalog-common": "workspace:^" "@backstage/plugin-catalog-node": "workspace:^" "@backstage/plugin-permission-common": "workspace:^" @@ -25825,7 +25825,7 @@ __metadata: "@backstage/plugin-azure-devops-backend": "workspace:^" "@backstage/plugin-badges-backend": "workspace:^" "@backstage/plugin-catalog-backend": "workspace:^" - "@backstage/plugin-catalog-backend-module-scaffolder-entities": "workspace:^" + "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "workspace:^" "@backstage/plugin-catalog-backend-module-unprocessed": "workspace:^" "@backstage/plugin-devtools-backend": "workspace:^" "@backstage/plugin-entity-feedback-backend": "workspace:^" @@ -25867,7 +25867,7 @@ __metadata: "@backstage/plugin-azure-sites-backend": "workspace:^" "@backstage/plugin-badges-backend": "workspace:^" "@backstage/plugin-catalog-backend": "workspace:^" - "@backstage/plugin-catalog-backend-module-scaffolder-entities": "workspace:^" + "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "workspace:^" "@backstage/plugin-catalog-backend-module-unprocessed": "workspace:^" "@backstage/plugin-catalog-node": "workspace:^" "@backstage/plugin-code-coverage-backend": "workspace:^"