@backstage/plugin-scaffolder-backend 1.13.2-next.2 → 1.14.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,64 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.14.1-next.0
+
+### Patch Changes
+
+- cc936b529676: Fix handling of `optional` property in `catalog:register` scaffolder action
+- b269da39ac2d: Clearer error messages for action `publish:gitlab:merge-request`
+- Updated dependencies
+  - @backstage/catalog-client@1.4.2-next.0
+  - @backstage/plugin-catalog-backend@1.9.2-next.0
+  - @backstage/plugin-catalog-node@1.3.7-next.0
+  - @backstage/backend-common@0.18.6-next.0
+  - @backstage/integration@1.4.5
+  - @backstage/config@1.0.7
+  - @backstage/backend-plugin-api@0.5.3-next.0
+  - @backstage/backend-tasks@0.5.3-next.0
+  - @backstage/catalog-model@1.3.0
+  - @backstage/errors@1.1.5
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.15-next.0
+  - @backstage/plugin-catalog-common@1.0.13
+  - @backstage/plugin-permission-common@0.7.5
+  - @backstage/plugin-permission-node@0.7.9-next.0
+  - @backstage/plugin-scaffolder-common@1.3.0
+  - @backstage/plugin-scaffolder-node@0.1.4-next.0
+
+## 1.14.0
+
+### Minor Changes
+
+- 67115f532b8: Expose both types of scaffolder permissions and rules through the metadata endpoint.
+
+  The metadata endpoint now correctly exposes both types of scaffolder permissions and rules (for both the template and action resource types) through the metadata endpoint.
+
+- a73b3c0b097: Add ability to use `defaultNamespace` and `defaultKind` for scaffolder action `catalog:fetch`
+
+### Patch Changes
+
+- 1a48b84901c: Bump minimum required version of `vm2` to be 3.9.18
+- d20c87966a4: Bump minimum required version of `vm2` to be 3.9.17
+- 6d954de4b06: Update typing for `RouterOptions::actions` and `ScaffolderActionsExtensionPoint::addActions` to allow any kind of action being assigned to it.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.9.1
+  - @backstage/backend-common@0.18.5
+  - @backstage/integration@1.4.5
+  - @backstage/plugin-scaffolder-common@1.3.0
+  - @backstage/plugin-permission-node@0.7.8
+  - @backstage/plugin-scaffolder-node@0.1.3
+  - @backstage/backend-tasks@0.5.2
+  - @backstage/plugin-auth-node@0.2.14
+  - @backstage/plugin-catalog-node@1.3.6
+  - @backstage/backend-plugin-api@0.5.2
+  - @backstage/catalog-client@1.4.1
+  - @backstage/catalog-model@1.3.0
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/types@1.0.2
+  - @backstage/plugin-catalog-common@1.0.13
+  - @backstage/plugin-permission-common@0.7.5
+
 ## 1.13.2-next.2
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.13.2-next.2",
+  "version": "1.14.1-next.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 backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-2f24bb9e.cjs.js');
+var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-c40021d1.cjs.js');
 var alpha$1 = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var backendCommon = require('@backstage/backend-common');

package/dist/cjs/{ScaffolderEntitiesProcessor-2f24bb9e.cjs.js → ScaffolderEntitiesProcessor-c40021d1.cjs.js}

@@ -179,13 +179,19 @@ function createCatalogRegisterAction(options) {
         });
       }
       ctx.logger.info(`Registering ${catalogInfoUrl} in the catalog`);
-      await catalogClient.addLocation(
-        {
-          type: "url",
-          target: catalogInfoUrl
-        },
-        ((_a = ctx.secrets) == null ? void 0 : _a.backstageToken) ? { token: ctx.secrets.backstageToken } : {}
-      );
+      try {
+        await catalogClient.addLocation(
+          {
+            type: "url",
+            target: catalogInfoUrl
+          },
+          ((_a = ctx.secrets) == null ? void 0 : _a.backstageToken) ? { token: ctx.secrets.backstageToken } : {}
+        );
+      } catch (e) {
+        if (!input.optional) {
+          throw e;
+        }
+      }
       try {
         const result = await catalogClient.addLocation(
           {
@@ -195,7 +201,7 @@ function createCatalogRegisterAction(options) {
           },
           ((_b = ctx.secrets) == null ? void 0 : _b.backstageToken) ? { token: ctx.secrets.backstageToken } : {}
         );
-        if (result.entities.length > 0) {
+        if (result.entities.length) {
           const { entities } = result;
           let entity;
           entity = entities.find(
@@ -317,6 +323,7 @@ function createFetchCatalogEntityAction(options) {
     id: id$2,
     description: "Returns entity or entities from the catalog by entity reference(s)",
     examples: examples$2,
+    supportsDryRun: true,
     schema: {
       input: zod.z.object({
         entityRef: zod.z.string({
@@ -327,7 +334,9 @@ function createFetchCatalogEntityAction(options) {
         }).optional(),
         optional: zod.z.boolean({
           description: "Allow the entity or entities to optionally exist. Default: false"
-        }).optional()
+        }).optional(),
+        defaultKind: zod.z.string({ description: "The default kind" }).optional(),
+        defaultNamespace: zod.z.string({ description: "The default namespace" }).optional()
       }),
       output: zod.z.object({
         entity: zod.z.any({
@@ -342,7 +351,7 @@ function createFetchCatalogEntityAction(options) {
     },
     async handler(ctx) {
       var _a, _b;
-      const { entityRef, entityRefs, optional } = ctx.input;
+      const { entityRef, entityRefs, optional, defaultKind, defaultNamespace } = ctx.input;
       if (!entityRef && !entityRefs) {
         if (optional) {
           return;
@@ -350,9 +359,14 @@ function createFetchCatalogEntityAction(options) {
         throw new Error("Missing entity reference or references");
       }
       if (entityRef) {
-        const entity = await catalogClient.getEntityByRef(entityRef, {
-          token: (_a = ctx.secrets) == null ? void 0 : _a.backstageToken
-        });
+        const entity = await catalogClient.getEntityByRef(
+          catalogModel.stringifyEntityRef(
+            catalogModel.parseEntityRef(entityRef, { defaultKind, defaultNamespace })
+          ),
+          {
+            token: (_a = ctx.secrets) == null ? void 0 : _a.backstageToken
+          }
+        );
         if (!entity && !optional) {
           throw new Error(`Entity ${entityRef} not found`);
         }
@@ -360,7 +374,13 @@ function createFetchCatalogEntityAction(options) {
       }
       if (entityRefs) {
         const entities = await catalogClient.getEntitiesByRefs(
-          { entityRefs },
+          {
+            entityRefs: entityRefs.map(
+              (ref) => catalogModel.stringifyEntityRef(
+                catalogModel.parseEntityRef(ref, { defaultKind, defaultNamespace })
+              )
+            )
+          },
           {
             token: (_b = ctx.secrets) == null ? void 0 : _b.backstageToken
           }
@@ -4236,13 +4256,15 @@ const createPublishGitlabMergeRequestAction = (options) => {
       try {
         await api.Branches.create(repoID, branchName, String(defaultBranch));
       } catch (e) {
-        throw new errors.InputError(`The branch creation failed ${e}`);
+        throw new errors.InputError(
+          `The branch creation failed. Please check that your repo does not already contain a branch named '${branchName}'. ${e}`
+        );
       }
       try {
         await api.Commits.create(repoID, branchName, ctx.input.title, actions);
       } catch (e) {
         throw new errors.InputError(
-          `Committing the changes to ${branchName} failed ${e}`
+          `Committing the changes to ${branchName} failed. Please check that none of the files created by the template already exists. ${e}`
         );
       }
       try {
@@ -5622,6 +5644,12 @@ async function findTemplate(options) {
   return template;
 }
 
+function isTemplatePermissionRuleInput(permissionRule) {
+  return permissionRule.resourceType === alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE;
+}
+function isActionPermissionRuleInput(permissionRule) {
+  return permissionRule.resourceType === alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION;
+}
 function isSupportedTemplate(entity) {
   return entity.apiVersion === "scaffolder.backstage.io/v1beta3";
 }
@@ -5753,14 +5781,29 @@ async function createRouter(options) {
   const templateRules = Object.values(
     scaffolderTemplateRules
   );
+  const actionRules = Object.values(
+    scaffolderActionRules
+  );
   if (permissionRules) {
-    templateRules.push(...permissionRules);
+    templateRules.push(
+      ...permissionRules.filter(isTemplatePermissionRuleInput)
+    );
+    actionRules.push(...permissionRules.filter(isActionPermissionRuleInput));
   }
   const isAuthorized = pluginPermissionNode.createConditionAuthorizer(Object.values(templateRules));
   const permissionIntegrationRouter = pluginPermissionNode.createPermissionIntegrationRouter({
-    resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
-    permissions: alpha.scaffolderPermissions,
-    rules: templateRules
+    resources: [
+      {
+        resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+        permissions: alpha.scaffolderTemplatePermissions,
+        rules: templateRules
+      },
+      {
+        resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION,
+        permissions: alpha.scaffolderActionPermissions,
+        rules: actionRules
+      }
+    ]
   });
   router.use(permissionIntegrationRouter);
   router.get(
@@ -6139,4 +6182,4 @@ exports.executeShellCommand = executeShellCommand;
 exports.fetchContents = fetchContents;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=ScaffolderEntitiesProcessor-2f24bb9e.cjs.js.map
+//# sourceMappingURL=ScaffolderEntitiesProcessor-c40021d1.cjs.js.map