renames

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

.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.

.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`.

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:
 

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:^",

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'));

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:^",

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';

plugins/catalog-backend-module-scaffolder-entities/README.md

@@ -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_

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.

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 {

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",

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';

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(

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: {

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';

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:^",

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;

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:^"