@backstage/plugin-scaffolder-backend 0.0.0-nightly-20220717025420 → 0.0.0-nightly-20220721025105

package/CHANGELOG.md

@@ -1,11 +1,29 @@
 # @backstage/plugin-scaffolder-backend
 
-## 0.0.0-nightly-20220717025420
+## 0.0.0-nightly-20220721025105
 
 ### Minor Changes
 
+- eeff5046ae: Updated `publish:gitlab:merge-request` action to allow commit updates and deletes
+
+### Patch Changes
+
+- fc8a5f797b: Add a `publish:gerrit:review` scaffolder action
+- Updated dependencies
+  - @backstage/backend-common@0.0.0-nightly-20220721025105
+  - @backstage/integration@0.0.0-nightly-20220721025105
+  - @backstage/backend-plugin-api@0.0.0-nightly-20220721025105
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220721025105
+
+## 1.4.0
+
+### 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 +58,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-20220717025420
-  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220717025420
-  - @backstage/backend-common@0.0.0-nightly-20220717025420
-  - @backstage/catalog-model@0.0.0-nightly-20220717025420
-  - @backstage/plugin-catalog-node@0.0.0-nightly-20220717025420
-  - @backstage/integration@0.0.0-nightly-20220717025420
-  - @backstage/catalog-client@0.0.0-nightly-20220717025420
-  - @backstage/errors@0.0.0-nightly-20220717025420
-  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220717025420
+  - @backstage/backend-plugin-api@0.1.0
+  - @backstage/plugin-catalog-backend@1.3.0
+  - @backstage/backend-common@0.14.1
+  - @backstage/catalog-model@1.1.0
+  - @backstage/plugin-catalog-node@1.0.0
+  - @backstage/integration@1.2.2
+  - @backstage/catalog-client@1.0.4
+  - @backstage/errors@1.1.0
+  - @backstage/plugin-scaffolder-common@1.1.2
 
 ## 1.4.0-next.3
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "0.0.0-nightly-20220717025420",
+  "version": "0.0.0-nightly-20220721025105",
   "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;
@@ -440,6 +441,22 @@ gitAuthorEmail?: string | undefined;
 sourcePath?: string | undefined;
 }>;
 
+/**
+ * Creates a new action that creates a Gerrit review
+ * @public
+ */
+export declare function createPublishGerritReviewAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+}): TemplateAction<    {
+repoUrl: string;
+branch?: string | undefined;
+sourcePath?: string | undefined;
+gitCommitMessage?: string | undefined;
+gitAuthorName?: string | undefined;
+gitAuthorEmail?: string | undefined;
+}>;
+
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
  * and publishes it to GitHub.
@@ -456,6 +473,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;
@@ -532,9 +550,11 @@ description: string;
 branchName: string;
 targetPath: string;
 token?: string | undefined;
+commitAction?: "create" | "update" | "delete" | 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;
@@ -440,6 +441,22 @@ gitAuthorEmail?: string | undefined;
 sourcePath?: string | undefined;
 }>;
 
+/**
+ * Creates a new action that creates a Gerrit review
+ * @public
+ */
+export declare function createPublishGerritReviewAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+}): TemplateAction<    {
+repoUrl: string;
+branch?: string | undefined;
+sourcePath?: string | undefined;
+gitCommitMessage?: string | undefined;
+gitAuthorName?: string | undefined;
+gitAuthorEmail?: string | undefined;
+}>;
+
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
  * and publishes it to GitHub.
@@ -456,6 +473,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;
@@ -532,9 +550,11 @@ description: string;
 branchName: string;
 targetPath: string;
 token?: string | undefined;
+commitAction?: "create" | "update" | "delete" | undefined;
 /** @deprecated Use projectPath instead */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;
+assignee?: string | undefined;
 }>;
 
 /**

package/dist/index.cjs.js

@@ -834,6 +834,40 @@ async function initRepoAndPush({
     remote: "origin"
   });
 }
+async function commitAndPushRepo({
+  dir,
+  auth,
+  logger,
+  commitMessage,
+  gitAuthorInfo,
+  branch = "master",
+  remoteRef
+}) {
+  var _a, _b;
+  const git = backendCommon.Git.fromAuth({
+    username: auth.username,
+    password: auth.password,
+    logger
+  });
+  await git.fetch({ dir });
+  await git.checkout({ dir, ref: branch });
+  await git.add({ dir, filepath: "." });
+  const authorInfo = {
+    name: (_a = gitAuthorInfo == null ? void 0 : gitAuthorInfo.name) != null ? _a : "Scaffolder",
+    email: (_b = gitAuthorInfo == null ? void 0 : gitAuthorInfo.email) != null ? _b : "scaffolder@backstage.io"
+  };
+  await git.commit({
+    dir,
+    message: commitMessage,
+    author: authorInfo,
+    committer: authorInfo
+  });
+  await git.push({
+    dir,
+    remote: "origin",
+    remoteRef: remoteRef != null ? remoteRef : `refs/heads/${branch}`
+  });
+}
 const enableBranchProtectionOnDefaultRepoBranch = async ({
   repoName,
   client,
@@ -841,7 +875,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   logger,
   requireCodeOwnerReviews,
   requiredStatusCheckContexts = [],
-  defaultBranch = "master"
+  defaultBranch = "master",
+  enforceAdmins = true
 }) => {
   const tryOnce = async () => {
     try {
@@ -857,7 +892,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 +1044,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 +1071,8 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         logger,
         defaultBranch,
         requireCodeOwnerReviews,
-        requiredStatusCheckContexts
+        requiredStatusCheckContexts,
+        enforceAdmins: protectEnforceAdmins
       });
     } catch (e) {
       errors.assertError(e);
@@ -1295,6 +1331,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 +1435,7 @@ function createGithubRepoPushAction(options) {
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
+          protectEnforceAdmins: protectEnforceAdmins,
           gitCommitMessage: gitCommitMessage,
           gitAuthorName: gitAuthorName,
           gitAuthorEmail: gitAuthorEmail,
@@ -1414,6 +1456,7 @@ function createGithubRepoPushAction(options) {
         repoUrl,
         defaultBranch = "master",
         protectDefaultBranch = true,
+        protectEnforceAdmins = true,
         gitCommitMessage = "initial commit",
         gitAuthorName,
         gitAuthorEmail,
@@ -1435,7 +1478,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);
     }
@@ -2438,6 +2481,113 @@ function createPublishGerritAction(options) {
   });
 }
 
+const generateGerritChangeId = () => {
+  const changeId = crypto__default["default"].randomBytes(20).toString("hex");
+  return `I${changeId}`;
+};
+function createPublishGerritReviewAction(options) {
+  const { integrations, config } = options;
+  return createTemplateAction({
+    id: "publish:gerrit:review",
+    description: "Creates a new Gerrit review.",
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl", "gitCommitMessage"],
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            type: "string"
+          },
+          branch: {
+            title: "Repository branch",
+            type: "string",
+            description: "Branch of the repository the review will be created on"
+          },
+          sourcePath: {
+            type: "string",
+            title: "Working Subdirectory",
+            description: "Subdirectory of working directory containing the repository"
+          },
+          gitCommitMessage: {
+            title: "Git Commit Message",
+            type: "string",
+            description: `Sets the commit message on the repository.`
+          },
+          gitAuthorName: {
+            title: "Default Author Name",
+            type: "string",
+            description: `Sets the default author name for the commit. The default value is 'Scaffolder'`
+          },
+          gitAuthorEmail: {
+            title: "Default Author Email",
+            type: "string",
+            description: `Sets the default author email for the commit.`
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          reviewUrl: {
+            title: "A URL to the review",
+            type: "string"
+          },
+          repoContentsUrl: {
+            title: "A URL to the root of the repository",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      var _a;
+      const {
+        repoUrl,
+        branch = "master",
+        sourcePath,
+        gitAuthorName,
+        gitAuthorEmail,
+        gitCommitMessage
+      } = ctx.input;
+      const { host, repo } = parseRepoUrl(repoUrl, integrations);
+      if (!gitCommitMessage) {
+        throw new errors.InputError(`Missing gitCommitMessage input`);
+      }
+      const integrationConfig = integrations.gerrit.byHost(host);
+      if (!integrationConfig) {
+        throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
+      }
+      const auth = {
+        username: integrationConfig.config.username,
+        password: integrationConfig.config.password
+      };
+      const gitAuthorInfo = {
+        name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
+        email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
+      };
+      const changeId = generateGerritChangeId();
+      const commitMessage = `${gitCommitMessage}
+
+Change-Id: ${changeId}`;
+      await commitAndPushRepo({
+        dir: getRepoSourceDirectory(ctx.workspacePath, sourcePath),
+        auth,
+        logger: ctx.logger,
+        commitMessage,
+        gitAuthorInfo,
+        branch,
+        remoteRef: `refs/for/${branch}`
+      });
+      const repoContentsUrl = `${integrationConfig.config.gitilesBaseUrl}/${repo}/+/refs/heads/${branch}`;
+      const reviewUrl = `${integrationConfig.config.baseUrl}/#/q/${changeId}`;
+      (_a = ctx.logger) == null ? void 0 : _a.info(`Review available on ${reviewUrl}`);
+      ctx.output("repoContentsUrl", repoContentsUrl);
+      ctx.output("reviewUrl", reviewUrl);
+    }
+  });
+}
+
 function createPublishGithubAction(options) {
   const { integrations, config, githubCredentialsProvider } = options;
   return createTemplateAction({
@@ -2456,6 +2606,7 @@ function createPublishGithubAction(options) {
           repoVisibility: repoVisibility,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
+          protectEnforceAdmins: protectEnforceAdmins,
           deleteBranchOnMerge: deleteBranchOnMerge,
           gitCommitMessage: gitCommitMessage,
           gitAuthorName: gitAuthorName,
@@ -2487,6 +2638,7 @@ function createPublishGithubAction(options) {
         repoVisibility = "private",
         defaultBranch = "master",
         protectDefaultBranch = true,
+        protectEnforceAdmins = true,
         deleteBranchOnMerge = false,
         gitCommitMessage = "initial commit",
         gitAuthorName,
@@ -2512,7 +2664,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);
     }
@@ -2889,10 +3041,21 @@ const createPublishGitlabMergeRequestAction = (options) => {
             type: "string",
             description: "The token to use for authorization to GitLab"
           },
+          commitAction: {
+            title: "Commit action",
+            type: "string",
+            enum: ["create", "update", "delete"],
+            description: "The action to be used for git commit. Defaults to create."
+          },
           removeSourceBranch: {
             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,17 +3102,30 @@ 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
       });
-      const actions = fileContents.map((file) => ({
-        action: "create",
-        filePath: path__default["default"].posix.join(ctx.input.targetPath, file.path),
-        encoding: "base64",
-        content: file.content.toString("base64"),
-        execute_filemode: file.executable
-      }));
+      const actions = fileContents.map((file) => {
+        var _a2;
+        return {
+          action: (_a2 = ctx.input.commitAction) != null ? _a2 : "create",
+          filePath: path__default["default"].posix.join(ctx.input.targetPath, file.path),
+          encoding: "base64",
+          content: file.content.toString("base64"),
+          execute_filemode: file.executable
+        };
+      });
       const projects = await api.Projects.show(projectPath);
       const { default_branch: defaultBranch } = projects;
       try {
@@ -2965,7 +3141,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;
         });
@@ -3002,6 +3179,10 @@ const createBuiltinActions = (options) => {
       integrations,
       config
     }),
+    createPublishGerritReviewAction({
+      integrations,
+      config
+    }),
     createPublishGithubAction({
       integrations,
       config,
@@ -3914,6 +4095,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,
@@ -4214,6 +4400,7 @@ exports.createPublishBitbucketCloudAction = createPublishBitbucketCloudAction;
 exports.createPublishBitbucketServerAction = createPublishBitbucketServerAction;
 exports.createPublishFileAction = createPublishFileAction;
 exports.createPublishGerritAction = createPublishGerritAction;
+exports.createPublishGerritReviewAction = createPublishGerritReviewAction;
 exports.createPublishGithubAction = createPublishGithubAction;
 exports.createPublishGithubPullRequestAction = createPublishGithubPullRequestAction;
 exports.createPublishGitlabAction = createPublishGitlabAction;