@backstage/plugin-catalog-backend 1.6.0-next.2 → 1.6.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-catalog-backend
 
+## 1.6.0-next.3
+
+### Patch Changes
+
+- ba13ff663c: Added a new `catalog.rules[].location` configuration that makes it possible to configure catalog rules to only apply to specific locations, either via exact match or a glob pattern.
+- b05dcd5530: Move the `zod` dependency to a version that does not collide with other libraries
+- 71147d5c16: Internal code reorganization.
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.7.2-next.2
+  - @backstage/plugin-permission-node@0.7.2-next.3
+  - @backstage/backend-common@0.17.0-next.3
+  - @backstage/backend-plugin-api@0.2.0-next.3
+  - @backstage/catalog-client@1.2.0-next.1
+  - @backstage/catalog-model@1.1.4-next.1
+  - @backstage/config@1.0.5-next.1
+  - @backstage/errors@1.1.4-next.1
+  - @backstage/integration@1.4.1-next.1
+  - @backstage/types@1.0.2-next.1
+  - @backstage/plugin-catalog-common@1.0.9-next.3
+  - @backstage/plugin-catalog-node@1.3.0-next.3
+  - @backstage/plugin-scaffolder-common@1.2.3-next.1
+  - @backstage/plugin-search-common@1.2.0-next.3
+
 ## 1.6.0-next.2
 
 ### Minor Changes

package/alpha/package.json

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

package/config.d.ts

@@ -38,6 +38,37 @@ export interface Config {
        * E.g. ["Component", "API", "Template", "Location"]
        */
       allow: Array<string>;
+      /**
+       * Limit this rule to a specific location
+       *
+       * Example with a fixed location
+       *  { "type": "url", "exact": "https://github.com/a/b/blob/file.yaml"}
+       *
+       * Example using a Regex
+       *  { "type": "url", "pattern": "https://github.com/org/*\/blob/master/*.yaml"}
+       *
+       * Using both exact and pattern will result in an error starting the application
+       */
+      locations?: Array<{
+        /**
+         * The type of location, e.g. "url".
+         */
+        type: string;
+        /**
+         * The exact location, e.g.
+         * "https://github.com/org/repo/blob/master/users.yaml".
+         *
+         * The exact location can also be used to match on locations
+         * that contain glob characters themselves, e.g.
+         * "https://github.com/org/*\/blob/master/*.yaml".
+         */
+        exact?: string;
+        /**
+         * The pattern allowed for the location, e.g.
+         * "https://github.com/org/*\/blob/master/*.yaml".
+         */
+        pattern?: string;
+      }>;
     }>;
 
     /**

package/dist/index.alpha.d.ts

@@ -392,7 +392,13 @@ export declare type CatalogPermissionRule<TParams extends PermissionRuleParams =
  */
 export declare const catalogPlugin: (options?: undefined) => BackendFeature;
 
-/** @public */
+/**
+ * Represents the engine that drives the processing loops. Some backend
+ * instances may choose to not call start, if they focus only on API
+ * interactions.
+ *
+ * @public
+ */
 export declare interface CatalogProcessingEngine {
     start(): Promise<void>;
     stop(): Promise<void>;

package/dist/index.beta.d.ts

@@ -345,7 +345,13 @@ export declare type CatalogEnvironment = {
 
 /* Excluded from this release type: catalogPlugin */
 
-/** @public */
+/**
+ * Represents the engine that drives the processing loops. Some backend
+ * instances may choose to not call start, if they focus only on API
+ * interactions.
+ *
+ * @public
+ */
 export declare interface CatalogProcessingEngine {
     start(): Promise<void>;
     stop(): Promise<void>;