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

package/CHANGELOG.md

@@ -1,6 +1,21 @@
 # @backstage/plugin-scaffolder-backend
 
-## 0.0.0-nightly-20220719025614
+## 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
 
@@ -43,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-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
+  - @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-20220719025614",
+  "version": "0.0.0-nightly-20220721025105",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -441,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.
@@ -534,6 +550,7 @@ description: string;
 branchName: string;
 targetPath: string;
 token?: string | undefined;
+commitAction?: "create" | "update" | "delete" | undefined;
 /** @deprecated Use projectPath instead */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;

package/dist/index.beta.d.ts

@@ -441,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.
@@ -534,6 +550,7 @@ description: string;
 branchName: string;
 targetPath: string;
 token?: string | undefined;
+commitAction?: "create" | "update" | "delete" | undefined;
 /** @deprecated Use projectPath instead */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | 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,
@@ -2447,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({
@@ -2900,6 +3041,12 @@ 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",
@@ -2969,13 +3116,16 @@ const createPublishGitlabMergeRequestAction = (options) => {
       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 {
@@ -3029,6 +3179,10 @@ const createBuiltinActions = (options) => {
       integrations,
       config
     }),
+    createPublishGerritReviewAction({
+      integrations,
+      config
+    }),
     createPublishGithubAction({
       integrations,
       config,
@@ -4246,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;