@backstage/plugin-catalog-backend-module-incremental-ingestion 0.6.4-next.2 → 0.6.5-next.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @backstage/plugin-catalog-backend-module-incremental-ingestion
 
+## 0.6.5-next.0
+
+### Patch Changes
+
+- 27d1031: fixed misleading example location annotations in docs
+- Updated dependencies
+  - @backstage/backend-defaults@0.9.0-next.0
+  - @backstage/plugin-catalog-backend@1.32.0
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-node@1.16.1
+  - @backstage/plugin-events-node@0.4.9
+  - @backstage/plugin-permission-common@0.8.4
+
+## 0.6.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.8.2
+  - @backstage/plugin-catalog-backend@1.32.0
+  - @backstage/plugin-events-node@0.4.9
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-node@1.16.1
+  - @backstage/plugin-permission-common@0.8.4
+
 ## 0.6.4-next.2
 
 ### Patch Changes

package/README.md

@@ -208,12 +208,20 @@ export class MyIncrementalEntityProvider
 The last step is to implement the actual `next` method that will accept the cursor, call the API, process the result and return the result.
 
 ```ts
+import {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
+} from '@backstage/catalog-model';
+import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-module-incremental-ingestion';
+
 export class MyIncrementalEntityProvider implements IncrementalEntityProvider<Cursor, Context> {
 
   token: string;
+  mySource: string;
 
-  constructor(token: string) {
+  constructor(token: string, mySource: string) {
     this.token = token;
+    this.mySource = mySource;
   }
 
   getProviderName() {
@@ -230,6 +238,7 @@ export class MyIncrementalEntityProvider implements IncrementalEntityProvider<Cu
 
   async next(context: Context, cursor?: Cursor = { page: 1 }): Promise<EntityIteratorResult<Cursor>> {
     const { apiClient } = context;
+    const location = `${this.getProviderName()}:${this.mySource}`;
 
     // call your API with the current cursor
     const data = await apiClient.getServices(cursor);
@@ -249,8 +258,8 @@ export class MyIncrementalEntityProvider implements IncrementalEntityProvider<Cu
           name: item.name,
           annotations: {
             // You need to define these, otherwise they'll fail validation
-            [ANNOTATION_LOCATION]: this.getProviderName(),
-            [ANNOTATION_ORIGIN_LOCATION]: this.getProviderName(),
+            [ANNOTATION_LOCATION]: location,
+            [ANNOTATION_ORIGIN_LOCATION]: location,
           }
         }
         spec: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-incremental-ingestion",
-  "version": "0.6.4-next.2",
+  "version": "0.6.5-next.0",
   "description": "An entity provider for streaming large asset sources into the catalog",
   "backstage": {
     "role": "backend-plugin-module",
@@ -65,14 +65,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "0.8.2-next.2",
-    "@backstage/backend-plugin-api": "1.2.1-next.1",
+    "@backstage/backend-defaults": "0.9.0-next.0",
+    "@backstage/backend-plugin-api": "1.2.1",
     "@backstage/catalog-model": "1.7.3",
     "@backstage/config": "1.3.2",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-catalog-backend": "1.32.0-next.2",
-    "@backstage/plugin-catalog-node": "1.16.1-next.1",
-    "@backstage/plugin-events-node": "0.4.9-next.2",
+    "@backstage/plugin-catalog-backend": "1.32.0",
+    "@backstage/plugin-catalog-node": "1.16.1",
+    "@backstage/plugin-events-node": "0.4.9",
     "@backstage/plugin-permission-common": "0.8.4",
     "@backstage/types": "1.2.1",
     "@opentelemetry/api": "^1.9.0",
@@ -84,8 +84,8 @@
     "uuid": "^11.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.1-next.2",
-    "@backstage/cli": "0.31.0-next.1",
+    "@backstage/backend-test-utils": "1.3.2-next.0",
+    "@backstage/cli": "0.32.0-next.0",
     "@types/luxon": "^3.0.0"
   }
 }