@backstage/plugin-scaffolder-backend 1.10.0-next.2 → 1.10.1

package/dist/index.cjs.js

@@ -82,14 +82,14 @@ const createTemplateAction = (templateAction) => {
   return templateAction;
 };
 
-const id$2 = "catalog:register";
-const examples$2 = [
+const id$3 = "catalog:register";
+const examples$3 = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$2,
+          action: id$3,
           id: "register-with-catalog",
           name: "Register with the catalog",
           input: {
@@ -103,9 +103,9 @@ const examples$2 = [
 function createCatalogRegisterAction(options) {
   const { catalogClient, integrations } = options;
   return createTemplateAction({
-    id: id$2,
+    id: id$3,
     description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
-    examples: examples$2,
+    examples: examples$3,
     schema: {
       input: {
         oneOf: [
@@ -223,14 +223,14 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const id$1 = "catalog:write";
-const examples$1 = [
+const id$2 = "catalog:write";
+const examples$2 = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
       steps: [
         {
-          action: id$1,
+          action: id$2,
           id: "create-catalog-info-file",
           name: "Create catalog file",
           input: {
@@ -255,9 +255,9 @@ const examples$1 = [
 ];
 function createCatalogWriteAction() {
   return createTemplateAction({
-    id: id$1,
+    id: id$2,
     description: "Writes the catalog-info.yaml for your template",
-    examples: examples$1,
+    examples: examples$2,
     schema: {
       input: {
         type: "object",
@@ -288,6 +288,76 @@ function createCatalogWriteAction() {
   });
 }
 
+const id$1 = "catalog:fetch";
+const examples$1 = [
+  {
+    description: "Fetch entity by reference",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: id$1,
+          id: "fetch",
+          name: "Fetch catalog entity",
+          input: {
+            entityRef: "component:default/name"
+          }
+        }
+      ]
+    })
+  }
+];
+function createFetchCatalogEntityAction(options) {
+  const { catalogClient } = options;
+  return createTemplateAction({
+    id: id$1,
+    description: "Returns entity from the catalog by entity reference",
+    examples: examples$1,
+    schema: {
+      input: {
+        required: ["entityRef"],
+        type: "object",
+        properties: {
+          entityRef: {
+            type: "string",
+            title: "Entity reference",
+            description: "Entity reference of the entity to get"
+          },
+          optional: {
+            title: "Optional",
+            description: "Permit the entity to optionally exist. Default: false",
+            type: "boolean"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          entity: {
+            title: "Entity found by the entity reference",
+            type: "object",
+            description: "Object containing same values used in the Entity schema."
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      var _a;
+      const { entityRef, optional } = ctx.input;
+      let entity;
+      try {
+        entity = await catalogClient.getEntityByRef(entityRef, {
+          token: (_a = ctx.secrets) == null ? void 0 : _a.backstageToken
+        });
+      } catch (e) {
+        if (!optional) {
+          throw e;
+        }
+      }
+      ctx.output("entity", entity != null ? entity : null);
+    }
+  });
+}
+
 const id = "debug:log";
 const examples = [
   {
@@ -1081,12 +1151,15 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   logger,
   requireCodeOwnerReviews,
   bypassPullRequestAllowances,
+  requiredApprovingReviewCount,
+  restrictions,
   requiredStatusCheckContexts = [],
   requireBranchesToBeUpToDate = true,
   requiredConversationResolution = false,
   defaultBranch = "master",
   enforceAdmins = true,
-  dismissStaleReviews = false
+  dismissStaleReviews = false,
+  requiredCommitSigning = false
 }) => {
   const tryOnce = async () => {
     try {
@@ -1108,16 +1181,23 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
           strict: requireBranchesToBeUpToDate,
           contexts: requiredStatusCheckContexts
         },
-        restrictions: null,
+        restrictions: restrictions != null ? restrictions : null,
         enforce_admins: enforceAdmins,
         required_pull_request_reviews: {
-          required_approving_review_count: 1,
+          required_approving_review_count: requiredApprovingReviewCount,
           require_code_owner_reviews: requireCodeOwnerReviews,
           bypass_pull_request_allowances: bypassPullRequestAllowances,
           dismiss_stale_reviews: dismissStaleReviews
         },
         required_conversation_resolution: requiredConversationResolution
       });
+      if (requiredCommitSigning) {
+        await client.rest.repos.createCommitSignatureProtection({
+          owner,
+          repo: repoName,
+          branch: defaultBranch
+        });
+      }
     } catch (e) {
       errors.assertError(e);
       if (e.message.includes(
@@ -1293,7 +1373,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
   }
   return newRepo;
 }
-async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, bypassPullRequestAllowances, requiredStatusCheckContexts, requireBranchesToBeUpToDate, requiredConversationResolution, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail, dismissStaleReviews) {
+async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, bypassPullRequestAllowances, requiredApprovingReviewCount, restrictions, requiredStatusCheckContexts, requireBranchesToBeUpToDate, requiredConversationResolution, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail, dismissStaleReviews, requiredCommitSigning) {
   const gitAuthorInfo = {
     name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
     email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
@@ -1320,12 +1400,15 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         logger,
         defaultBranch,
         bypassPullRequestAllowances,
+        requiredApprovingReviewCount,
+        restrictions,
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         requiredConversationResolution,
         enforceAdmins: protectEnforceAdmins,
-        dismissStaleReviews
+        dismissStaleReviews,
+        requiredCommitSigning
       });
     } catch (e) {
       errors.assertError(e);
@@ -1683,6 +1766,42 @@ const sourcePath = {
   description: "Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository.",
   type: "string"
 };
+const requiredApprovingReviewCount = {
+  title: "Required approving review count",
+  type: "number",
+  description: `Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. Defaults to 1.`
+};
+const restrictions = {
+  title: "Restrict who can push to the protected branch",
+  description: "Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories.",
+  type: "object",
+  additionalProperties: false,
+  properties: {
+    apps: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    },
+    users: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    },
+    teams: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    }
+  }
+};
+const requiredCommitSigning = {
+  title: "Require commit signing",
+  type: "boolean",
+  description: `Require commit signing so that you must sign commits on this branch.`
+};
 
 const remoteUrl = {
   title: "A URL to the repository with the provider",
@@ -1709,6 +1828,8 @@ function createGithubRepoCreateAction(options) {
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
+          requiredApprovingReviewCount: requiredApprovingReviewCount,
+          restrictions: restrictions,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           requiredConversationResolution: requiredConversationResolution,
@@ -1725,7 +1846,8 @@ function createGithubRepoCreateAction(options) {
           hasWiki: hasWiki,
           hasIssues: hasIssues,
           token: token,
-          topics: topics
+          topics: topics,
+          requiredCommitSigning: requiredCommitSigning
         }
       },
       output: {
@@ -1810,6 +1932,8 @@ function createGithubRepoPushAction(options) {
           dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
+          requiredApprovingReviewCount: requiredApprovingReviewCount,
+          restrictions: restrictions,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           requiredConversationResolution: requiredConversationResolution,
           defaultBranch: defaultBranch,
@@ -1819,7 +1943,8 @@ function createGithubRepoPushAction(options) {
           gitAuthorName: gitAuthorName,
           gitAuthorEmail: gitAuthorEmail,
           sourcePath: sourcePath,
-          token: token
+          token: token,
+          requiredCommitSigning: requiredCommitSigning
         }
       },
       output: {
@@ -1842,10 +1967,13 @@ function createGithubRepoPushAction(options) {
         requireCodeOwnerReviews = false,
         dismissStaleReviews = false,
         bypassPullRequestAllowances,
+        requiredApprovingReviewCount = 1,
+        restrictions,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
         requiredConversationResolution = false,
-        token: providedToken
+        token: providedToken,
+        requiredCommitSigning = false
       } = ctx.input;
       const { owner, repo } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -1874,6 +2002,8 @@ function createGithubRepoPushAction(options) {
         repo,
         requireCodeOwnerReviews,
         bypassPullRequestAllowances,
+        requiredApprovingReviewCount,
+        restrictions,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         requiredConversationResolution,
@@ -1882,7 +2012,8 @@ function createGithubRepoPushAction(options) {
         gitCommitMessage,
         gitAuthorName,
         gitAuthorEmail,
-        dismissStaleReviews
+        dismissStaleReviews,
+        requiredCommitSigning
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -2734,6 +2865,21 @@ function createPublishBitbucketServerAction(options) {
             title: "Authentication Token",
             type: "string",
             description: "The token to use for authorization to BitBucket Server"
+          },
+          gitCommitMessage: {
+            title: "Git Commit Message",
+            type: "string",
+            description: `Sets the commit message on the repository. The default value is 'initial commit'`
+          },
+          gitAuthorName: {
+            title: "Author Name",
+            type: "string",
+            description: `Sets the author name for the commit. The default value is 'Scaffolder'`
+          },
+          gitAuthorEmail: {
+            title: "Author Email",
+            type: "string",
+            description: `Sets the author email for the commit.`
           }
         }
       },
@@ -2758,7 +2904,10 @@ function createPublishBitbucketServerAction(options) {
         description,
         defaultBranch = "master",
         repoVisibility = "private",
-        enableLFS = false
+        enableLFS = false,
+        gitCommitMessage = "initial commit",
+        gitAuthorName,
+        gitAuthorEmail
       } = ctx.input;
       const { project, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!project) {
@@ -2795,8 +2944,8 @@ function createPublishBitbucketServerAction(options) {
         apiBaseUrl
       });
       const gitAuthorInfo = {
-        name: config.getOptionalString("scaffolder.defaultAuthor.name"),
-        email: config.getOptionalString("scaffolder.defaultAuthor.email")
+        name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
+        email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
       };
       const auth = authConfig.token ? {
         token
@@ -2810,9 +2959,7 @@ function createPublishBitbucketServerAction(options) {
         auth,
         defaultBranch,
         logger: ctx.logger,
-        commitMessage: config.getOptionalString(
-          "scaffolder.defaultCommitMessage"
-        ),
+        commitMessage: gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage"),
         gitAuthorInfo
       });
       if (enableLFS) {
@@ -3095,6 +3242,8 @@ function createPublishGithubAction(options) {
           homepage: homepage,
           access: access,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
+          requiredApprovingReviewCount: requiredApprovingReviewCount,
+          restrictions: restrictions,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
@@ -3120,7 +3269,8 @@ function createPublishGithubAction(options) {
           hasWiki: hasWiki,
           hasIssues: hasIssues,
           token: token,
-          topics: topics
+          topics: topics,
+          requiredCommitSigning: requiredCommitSigning
         }
       },
       output: {
@@ -3140,6 +3290,8 @@ function createPublishGithubAction(options) {
         requireCodeOwnerReviews = false,
         dismissStaleReviews = false,
         bypassPullRequestAllowances,
+        requiredApprovingReviewCount = 1,
+        restrictions,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
         requiredConversationResolution = false,
@@ -3162,7 +3314,8 @@ function createPublishGithubAction(options) {
         hasWiki = void 0,
         hasIssues = void 0,
         topics,
-        token: providedToken
+        token: providedToken,
+        requiredCommitSigning = false
       } = ctx.input;
       const octokitOptions = await getOctokitOptions({
         integrations,
@@ -3212,6 +3365,8 @@ function createPublishGithubAction(options) {
         repo,
         requireCodeOwnerReviews,
         bypassPullRequestAllowances,
+        requiredApprovingReviewCount,
+        restrictions,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         requiredConversationResolution,
@@ -3220,7 +3375,8 @@ function createPublishGithubAction(options) {
         gitCommitMessage,
         gitAuthorName,
         gitAuthorEmail,
-        dismissStaleReviews
+        dismissStaleReviews,
+        requiredCommitSigning
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -3931,6 +4087,7 @@ const createBuiltinActions = (options) => {
     }),
     createDebugLogAction(),
     createCatalogRegisterAction({ catalogClient, integrations }),
+    createFetchCatalogEntityAction({ catalogClient }),
     createCatalogWriteAction(),
     createFilesystemDeleteAction(),
     createFilesystemRenameAction(),
@@ -5507,71 +5664,73 @@ _actions = new WeakMap();
 const scaffolderActionsExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "scaffolder.actions"
 });
-const scaffolderPlugin = backendPluginApi.createBackendPlugin({
-  id: "scaffolder",
-  register(env, options) {
-    const actionsExtensions = new ScaffolderActionsExtensionPointImpl();
-    env.registerExtensionPoint(
-      scaffolderActionsExtensionPoint,
-      actionsExtensions
-    );
-    env.registerInit({
-      deps: {
-        logger: backendPluginApi.coreServices.logger,
-        config: backendPluginApi.coreServices.config,
-        reader: backendPluginApi.coreServices.urlReader,
-        permissions: backendPluginApi.coreServices.permissions,
-        database: backendPluginApi.coreServices.database,
-        httpRouter: backendPluginApi.coreServices.httpRouter,
-        catalogClient: pluginCatalogNode.catalogServiceRef
-      },
-      async init({
-        logger,
-        config,
-        reader,
-        database,
-        httpRouter,
-        catalogClient
-      }) {
-        const {
-          additionalTemplateFilters,
-          taskBroker,
-          taskWorkers,
-          additionalTemplateGlobals
-        } = options;
-        const log = backendCommon.loggerToWinstonLogger(logger);
-        const actions = options.actions || [
-          ...actionsExtensions.actions,
-          ...createBuiltinActions({
-            integrations: integration.ScmIntegrations.fromConfig(config),
+const scaffolderPlugin = backendPluginApi.createBackendPlugin(
+  (options) => ({
+    id: "scaffolder",
+    register(env) {
+      const actionsExtensions = new ScaffolderActionsExtensionPointImpl();
+      env.registerExtensionPoint(
+        scaffolderActionsExtensionPoint,
+        actionsExtensions
+      );
+      env.registerInit({
+        deps: {
+          logger: backendPluginApi.coreServices.logger,
+          config: backendPluginApi.coreServices.config,
+          reader: backendPluginApi.coreServices.urlReader,
+          permissions: backendPluginApi.coreServices.permissions,
+          database: backendPluginApi.coreServices.database,
+          httpRouter: backendPluginApi.coreServices.httpRouter,
+          catalogClient: pluginCatalogNode.catalogServiceRef
+        },
+        async init({
+          logger,
+          config,
+          reader,
+          database,
+          httpRouter,
+          catalogClient
+        }) {
+          const {
+            additionalTemplateFilters,
+            taskBroker,
+            taskWorkers,
+            additionalTemplateGlobals
+          } = options;
+          const log = backendCommon.loggerToWinstonLogger(logger);
+          const actions = options.actions || [
+            ...actionsExtensions.actions,
+            ...createBuiltinActions({
+              integrations: integration.ScmIntegrations.fromConfig(config),
+              catalogClient,
+              reader,
+              config,
+              additionalTemplateFilters,
+              additionalTemplateGlobals
+            })
+          ];
+          const actionIds = actions.map((action) => action.id).join(", ");
+          log.info(
+            `Starting scaffolder with the following actions enabled ${actionIds}`
+          );
+          const router = await createRouter({
+            logger: log,
+            config,
+            database,
             catalogClient,
             reader,
-            config,
+            actions,
+            taskBroker,
+            taskWorkers,
             additionalTemplateFilters,
             additionalTemplateGlobals
-          })
-        ];
-        const actionIds = actions.map((action) => action.id).join(", ");
-        log.info(
-          `Starting scaffolder with the following actions enabled ${actionIds}`
-        );
-        const router = await createRouter({
-          logger: log,
-          config,
-          database,
-          catalogClient,
-          reader,
-          actions,
-          taskBroker,
-          taskWorkers,
-          additionalTemplateFilters,
-          additionalTemplateGlobals
-        });
-        httpRouter.use(router);
-      }
-    });
-  }
-});
+          });
+          httpRouter.use(router);
+        }
+      });
+    }
+  })
+);
 
 exports.DatabaseTaskStore = DatabaseTaskStore;
 exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
@@ -5582,6 +5741,7 @@ exports.createBuiltinActions = createBuiltinActions;
 exports.createCatalogRegisterAction = createCatalogRegisterAction;
 exports.createCatalogWriteAction = createCatalogWriteAction;
 exports.createDebugLogAction = createDebugLogAction;
+exports.createFetchCatalogEntityAction = createFetchCatalogEntityAction;
 exports.createFetchPlainAction = createFetchPlainAction;
 exports.createFetchTemplateAction = createFetchTemplateAction;
 exports.createFilesystemDeleteAction = createFilesystemDeleteAction;