@backstage/plugin-catalog-backend 1.22.0-next.2 → 1.22.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-catalog-backend
 
+## 1.22.0
+
+### Minor Changes
+
+- f2a2a83: Deprecated the `LocationAnalyzer` type, which has been moved to `@backstage/plugin-catalog-node`.
+- f2a2a83: The `/alpha` plugin export has had its implementation of the `catalogAnalysisExtensionPoint` updated to reflect the new API.
+- 8d14475: Emit well known relationships for the Domain entity kind.
+
+### Patch Changes
+
+- 131e5cb: Fix broken links in README.
+- c6cb568: Add lifecycle monitoring for the catalog processing
+- d229dc4: Move path utilities from `backend-common` to the `backend-plugin-api` package.
+- 8479a0b: Fixed bug in stitching queue gauge that included entities that are scheduled in the future.
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.12.0
+  - @backstage/plugin-search-backend-module-catalog@0.1.24
+  - @backstage/catalog-model@1.5.0
+  - @backstage/backend-common@0.22.0
+  - @backstage/backend-plugin-api@0.6.18
+  - @backstage/backend-tasks@0.5.23
+  - @backstage/plugin-events-node@0.3.4
+  - @backstage/integration@1.11.0
+  - @backstage/backend-openapi-utils@0.1.11
+  - @backstage/catalog-client@1.6.5
+  - @backstage/plugin-catalog-common@1.0.23
+  - @backstage/plugin-permission-node@0.7.29
+
 ## 1.22.0-next.2
 
 ### Minor Changes
@@ -3574,8 +3602,7 @@
   `packages/backend/src/plugins/catalog.ts` creates the catalog builder using
   `CatalogBuilder.create`. If you instead call `new CatalogBuilder`, you are on
   the old implementation and will experience breakage if you upgrade to this
-  version. If you are still on the old version, see [the relevant change log
-  entry](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/CHANGELOG.md#patch-changes-27)
+  version. If you are still on the old version, see [the relevant change log entry](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/CHANGELOG.md#patch-changes-27)
   for migration instructions.
 
   The minimal `packages/backend/src/plugins/catalog.ts` file is now:
@@ -3668,8 +3695,7 @@
   `packages/backend/src/plugins/catalog.ts` creates the catalog builder using
   `CatalogBuilder.create`. If you instead call `new CatalogBuilder`, you are on
   the old implementation and will experience breakage if you upgrade to this
-  version. If you are still on the old version, see [the relevant change log
-  entry](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/CHANGELOG.md#patch-changes-27)
+  version. If you are still on the old version, see [the relevant change log entry](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/CHANGELOG.md#patch-changes-27)
   for migration instructions.
 
   The minimal `packages/backend/src/plugins/catalog.ts` file is now:

package/README.md

@@ -1,9 +1,7 @@
 # Catalog Backend
 
-This is the backend for the default Backstage [software
-catalog](http://backstage.io/docs/features/software-catalog/).
-This provides an API for consumers such as the frontend [catalog
-plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog).
+This is the backend for the default Backstage [software catalog](http://backstage.io/docs/features/software-catalog/).
+This provides an API for consumers such as the frontend [catalog plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog).
 
 It comes with a builtin database-backed implementation of the catalog that can
 store and serve your catalog for you.
@@ -30,12 +28,19 @@ restoring the plugin, if you previously removed it.
 yarn --cwd packages/backend add @backstage/plugin-catalog-backend
 ```
 
-### Adding the plugin to your `packages/backend`
+Then add the plugin to your backend, typically in `packages/backend/src/index.ts`:
 
-You'll need to add the plugin to the router in your `backend` package. You can
-do this by creating a file called `packages/backend/src/plugins/catalog.ts` with
-contents matching [catalog.ts in the create-app
-template](https://github.com/backstage/backstage/blob/master/packages/create-app/templates/default-app/packages/backend/src/plugins/catalog.ts).
+```ts
+const backend = createBackend();
+// ...
+backend.add(import('@backstage/plugin-catalog-backend/alpha'));
+```
+
+#### Old backend system
+
+In the old backend system there's a bit more wiring required. You'll need to
+create a file called `packages/backend/src/plugins/catalog.ts` with contents
+matching [catalog.ts in the create-app template](https://github.com/backstage/backstage/blob/ad9314d3a7e0405719ba93badf96e97adde8ef83/packages/create-app/templates/default-app/packages/backend/src/plugins/catalog.ts).
 
 With the `catalog.ts` router setup in place, add the router to
 `packages/backend/src/index.ts`:
@@ -60,10 +65,8 @@ async function main() {
 ### Adding catalog entities
 
 At this point the `catalog-backend` is installed in your backend package, but
-you will not have any catalog entities loaded. See [Catalog
-Configuration](https://backstage.io/docs/features/software-catalog/configuration)
-for how to add locations, or copy the catalog locations from the [create-app
-template](https://github.com/backstage/backstage/blob/master/packages/create-app/templates/default-app/app-config.yaml.hbs)
+you will not have any catalog entities loaded. See [Catalog Configuration](https://backstage.io/docs/features/software-catalog/configuration)
+for how to add locations, or copy the catalog locations from the [create-app template](https://github.com/backstage/backstage/blob/master/packages/create-app/templates/default-app/app-config.yaml.hbs)
 to get up and running quickly.
 
 ## Development

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.22.0-next.2",
+  "version": "1.22.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var alpha = require('@backstage/plugin-catalog-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
-var CatalogBuilder = require('./cjs/CatalogBuilder-2s1MuhaE.cjs.js');
+var CatalogBuilder = require('./cjs/CatalogBuilder-g0TDave-.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
 var lodash = require('lodash');

package/dist/cjs/{CatalogBuilder-2s1MuhaE.cjs.js → CatalogBuilder-g0TDave-.cjs.js}

@@ -21,6 +21,7 @@ var luxon = require('luxon');
 var promClient = require('prom-client');
 var api = require('@opentelemetry/api');
 var stableStringify = require('fast-json-stable-stringify');
+var backendPluginApi = require('@backstage/backend-plugin-api');
 var uniq = require('lodash/uniq');
 var splitToChunks = require('lodash/chunk');
 var zod = require('zod');
@@ -1504,7 +1505,7 @@ class DefaultProcessingDatabase {
 }
 
 async function applyDatabaseMigrations(knex) {
-  const migrationsDir = backendCommon.resolvePackagePath(
+  const migrationsDir = backendPluginApi.resolvePackagePath(
     "@backstage/plugin-catalog-backend",
     "migrations"
   );
@@ -7398,4 +7399,4 @@ exports.createCatalogPermissionRule = createCatalogPermissionRule;
 exports.createRandomProcessingInterval = createRandomProcessingInterval;
 exports.parseEntityYaml = parseEntityYaml;
 exports.permissionRules = permissionRules;
-//# sourceMappingURL=CatalogBuilder-2s1MuhaE.cjs.js.map
+//# sourceMappingURL=CatalogBuilder-g0TDave-.cjs.js.map