@backstage/plugin-scaffolder-backend 0.0.0-nightly-20220718024938 → 0.0.0-nightly-20220719025614

package/CHANGELOG.md

@@ -1,11 +1,14 @@
 # @backstage/plugin-scaffolder-backend
 
-## 0.0.0-nightly-20220718024938
+## 0.0.0-nightly-20220719025614
 
 ### Minor Changes
 
+- e1a08d872c: Added optional assignee parameter for Gitlab Merge Request action
+- dab9bcf2e7: Add `protectEnforceAdmins` as an option to GitHub publish actions
 - 4baf8a4ece: Update GitLab Merge Request Action to allow source branch to be deleted
 - 91c1d12123: Export experimental `scaffolderCatalogExtension` for the new backend system. This export is not considered stable and should not be used in production.
+- d10ccc2ed1: Introduced audit log message when a new scaffolder task is created
 - 2db07887cb: Added two new scaffolder actions: `github:repo:create` and `github:repo:push`
 
 ### Patch Changes
@@ -40,15 +43,15 @@
 - 945a27fa6a: Add sourcePath option to publish:gerrit action
 - 1764296a68: Allow to create Gerrit project using default owner
 - Updated dependencies
-  - @backstage/backend-plugin-api@0.0.0-nightly-20220718024938
-  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220718024938
-  - @backstage/backend-common@0.0.0-nightly-20220718024938
-  - @backstage/catalog-model@0.0.0-nightly-20220718024938
-  - @backstage/plugin-catalog-node@0.0.0-nightly-20220718024938
-  - @backstage/integration@0.0.0-nightly-20220718024938
-  - @backstage/catalog-client@0.0.0-nightly-20220718024938
-  - @backstage/errors@0.0.0-nightly-20220718024938
-  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220718024938
+  - @backstage/backend-plugin-api@0.0.0-nightly-20220719025614
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220719025614
+  - @backstage/backend-common@0.0.0-nightly-20220719025614
+  - @backstage/catalog-model@0.0.0-nightly-20220719025614
+  - @backstage/plugin-catalog-node@0.0.0-nightly-20220719025614
+  - @backstage/integration@0.0.0-nightly-20220719025614
+  - @backstage/catalog-client@0.0.0-nightly-20220719025614
+  - @backstage/errors@0.0.0-nightly-20220719025614
+  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220719025614
 
 ## 1.4.0-next.3
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "0.0.0-nightly-20220718024938",
+  "version": "0.0.0-nightly-20220719025614",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -303,6 +303,7 @@ repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
+protectEnforceAdmins?: boolean | undefined;
 gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
@@ -456,6 +457,7 @@ description?: string | undefined;
 access?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
+protectEnforceAdmins?: boolean | undefined;
 deleteBranchOnMerge?: boolean | undefined;
 gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
@@ -535,6 +537,7 @@ token?: string | undefined;
 /** @deprecated Use projectPath instead */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;
+assignee?: string | undefined;
 }>;
 
 /**

package/dist/index.beta.d.ts

@@ -303,6 +303,7 @@ repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
+protectEnforceAdmins?: boolean | undefined;
 gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
@@ -456,6 +457,7 @@ description?: string | undefined;
 access?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
+protectEnforceAdmins?: boolean | undefined;
 deleteBranchOnMerge?: boolean | undefined;
 gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
@@ -535,6 +537,7 @@ token?: string | undefined;
 /** @deprecated Use projectPath instead */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;
+assignee?: string | undefined;
 }>;
 
 /**

package/dist/index.cjs.js

@@ -841,7 +841,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   logger,
   requireCodeOwnerReviews,
   requiredStatusCheckContexts = [],
-  defaultBranch = "master"
+  defaultBranch = "master",
+  enforceAdmins = true
 }) => {
   const tryOnce = async () => {
     try {
@@ -857,7 +858,7 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
           contexts: requiredStatusCheckContexts
         },
         restrictions: null,
-        enforce_admins: true,
+        enforce_admins: enforceAdmins,
         required_pull_request_reviews: {
           required_approving_review_count: 1,
           require_code_owner_reviews: requireCodeOwnerReviews
@@ -1009,7 +1010,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
   }
   return newRepo;
 }
-async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail) {
+async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail) {
   const gitAuthorInfo = {
     name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
     email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
@@ -1036,7 +1037,8 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         logger,
         defaultBranch,
         requireCodeOwnerReviews,
-        requiredStatusCheckContexts
+        requiredStatusCheckContexts,
+        enforceAdmins: protectEnforceAdmins
       });
     } catch (e) {
       errors.assertError(e);
@@ -1295,6 +1297,11 @@ const protectDefaultBranch = {
   type: "boolean",
   description: `Protect the default branch after creating the repository. The default value is 'true'`
 };
+const protectEnforceAdmins = {
+  title: "Enforce Admins On Protected Branches",
+  type: "boolean",
+  description: `Enforce admins to adhere to default branch protection. The default value is 'true'`
+};
 const gitCommitMessage = {
   title: "Git Commit Message",
   type: "string",
@@ -1394,6 +1401,7 @@ function createGithubRepoPushAction(options) {
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
+          protectEnforceAdmins: protectEnforceAdmins,
           gitCommitMessage: gitCommitMessage,
           gitAuthorName: gitAuthorName,
           gitAuthorEmail: gitAuthorEmail,
@@ -1414,6 +1422,7 @@ function createGithubRepoPushAction(options) {
         repoUrl,
         defaultBranch = "master",
         protectDefaultBranch = true,
+        protectEnforceAdmins = true,
         gitCommitMessage = "initial commit",
         gitAuthorName,
         gitAuthorEmail,
@@ -1435,7 +1444,7 @@ function createGithubRepoPushAction(options) {
       const targetRepo = await client.rest.repos.get({ owner, repo });
       const remoteUrl = targetRepo.data.clone_url;
       const repoContentsUrl = `${targetRepo.data.html_url}/blob/${defaultBranch}`;
-      await initRepoPushAndProtect(remoteUrl, octokitOptions.auth, ctx.workspacePath, ctx.input.sourcePath, defaultBranch, protectDefaultBranch, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, config, ctx.logger, gitCommitMessage, gitAuthorName, gitAuthorEmail);
+      await initRepoPushAndProtect(remoteUrl, octokitOptions.auth, ctx.workspacePath, ctx.input.sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, config, ctx.logger, gitCommitMessage, gitAuthorName, gitAuthorEmail);
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
     }
@@ -2456,6 +2465,7 @@ function createPublishGithubAction(options) {
           repoVisibility: repoVisibility,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
+          protectEnforceAdmins: protectEnforceAdmins,
           deleteBranchOnMerge: deleteBranchOnMerge,
           gitCommitMessage: gitCommitMessage,
           gitAuthorName: gitAuthorName,
@@ -2487,6 +2497,7 @@ function createPublishGithubAction(options) {
         repoVisibility = "private",
         defaultBranch = "master",
         protectDefaultBranch = true,
+        protectEnforceAdmins = true,
         deleteBranchOnMerge = false,
         gitCommitMessage = "initial commit",
         gitAuthorName,
@@ -2512,7 +2523,7 @@ function createPublishGithubAction(options) {
       const newRepo = await createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, allowRebaseMerge, access, collaborators, topics, ctx.logger);
       const remoteUrl = newRepo.clone_url;
       const repoContentsUrl = `${newRepo.html_url}/blob/${defaultBranch}`;
-      await initRepoPushAndProtect(remoteUrl, octokitOptions.auth, ctx.workspacePath, ctx.input.sourcePath, defaultBranch, protectDefaultBranch, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, config, ctx.logger, gitCommitMessage, gitAuthorName, gitAuthorEmail);
+      await initRepoPushAndProtect(remoteUrl, octokitOptions.auth, ctx.workspacePath, ctx.input.sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, config, ctx.logger, gitCommitMessage, gitAuthorName, gitAuthorEmail);
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
     }
@@ -2893,6 +2904,11 @@ const createPublishGitlabMergeRequestAction = (options) => {
             title: "Delete source branch",
             type: "boolean",
             description: "Option to delete source branch once the MR has been merged. Default: false"
+          },
+          assignee: {
+            title: "Merge Request Assignee",
+            type: "string",
+            description: "User this merge request will be assigned to"
           }
         }
       },
@@ -2939,6 +2955,16 @@ const createPublishGitlabMergeRequestAction = (options) => {
         host: integrationConfig.config.baseUrl,
         [tokenType]: token
       });
+      const assignee = ctx.input.assignee;
+      let assigneeId = void 0;
+      if (assignee !== void 0) {
+        try {
+          const assigneeUser = await api.Users.username(assignee);
+          assigneeId = assigneeUser[0].id;
+        } catch (e) {
+          ctx.logger.warn(`Failed to find gitlab user id for ${assignee}: ${e}. Proceeding with MR creation without an assignee.`);
+        }
+      }
       const targetPath = backendCommon.resolveSafeChildPath(ctx.workspacePath, ctx.input.targetPath);
       const fileContents = await serializeDirectoryContents(targetPath, {
         gitignore: true
@@ -2965,7 +2991,8 @@ const createPublishGitlabMergeRequestAction = (options) => {
       try {
         const mergeRequestUrl = await api.MergeRequests.create(projectPath, destinationBranch, String(defaultBranch), ctx.input.title, {
           description: ctx.input.description,
-          removeSourceBranch: ctx.input.removeSourceBranch ? ctx.input.removeSourceBranch : false
+          removeSourceBranch: ctx.input.removeSourceBranch ? ctx.input.removeSourceBranch : false,
+          assigneeId
         }).then((mergeRequest) => {
           return mergeRequest.web_url;
         });
@@ -3914,6 +3941,11 @@ async function createRouter(options) {
     });
     const { token, entityRef: userEntityRef } = parseBearerToken(req.headers.authorization);
     const userEntity = userEntityRef ? await catalogClient.getEntityByRef(userEntityRef, { token }) : void 0;
+    let auditLog = `Scaffolding task for ${templateRef}`;
+    if (userEntityRef) {
+      auditLog += ` created by ${userEntityRef}`;
+    }
+    logger.info(auditLog);
     const values = req.body.values;
     const template = await findTemplate({
       catalogApi: catalogClient,