@backstage/plugin-scaffolder-backend 1.2.0 → 1.3.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.3.0-next.0
+
+### Minor Changes
+
+- 72dfcbc8bf: A new scaffolder action has been added: `gerrit:publish`
+
+### Patch Changes
+
+- 6901f6be4a: Adds more of an explanation when the `publish:github` scaffolder action fails to create a repository.
+- Updated dependencies
+  - @backstage/backend-common@0.13.6-next.0
+  - @backstage/integration@1.2.1-next.0
+  - @backstage/plugin-catalog-backend@1.2.0-next.0
+
 ## 1.2.0
 
 ### Minor Changes

package/dist/index.cjs.js

@@ -16,6 +16,7 @@ var child_process = require('child_process');
 var stream = require('stream');
 var azureDevopsNodeApi = require('azure-devops-node-api');
 var fetch = require('node-fetch');
+var crypto = require('crypto');
 var octokit = require('octokit');
 var lodash = require('lodash');
 var octokitPluginCreatePullRequest = require('octokit-plugin-create-pull-request');
@@ -58,6 +59,7 @@ var yaml__namespace = /*#__PURE__*/_interopNamespace(yaml);
 var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var globby__default = /*#__PURE__*/_interopDefaultLegacy(globby);
 var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+var crypto__default = /*#__PURE__*/_interopDefaultLegacy(crypto);
 var ObservableImpl__default = /*#__PURE__*/_interopDefaultLegacy(ObservableImpl);
 var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
@@ -1578,6 +1580,138 @@ function createPublishFileAction() {
   });
 }
 
+const createGerritProject = async (config, options) => {
+  const { projectName, parent, owner, description } = options;
+  const fetchOptions = {
+    method: "PUT",
+    body: JSON.stringify({
+      parent,
+      description,
+      owners: [owner],
+      create_empty_commit: false
+    }),
+    headers: {
+      ...integration.getGerritRequestOptions(config).headers,
+      "Content-Type": "application/json"
+    }
+  };
+  const response = await fetch__default["default"](`${config.baseUrl}/a/projects/${encodeURIComponent(projectName)}`, fetchOptions);
+  if (response.status !== 201) {
+    throw new Error(`Unable to create repository, ${response.status} ${response.statusText}, ${await response.text()}`);
+  }
+};
+const generateCommitMessage = (config, commitSubject) => {
+  const changeId = crypto__default["default"].randomBytes(20).toString("hex");
+  const msg = `${config.getOptionalString("scaffolder.defaultCommitMessage") || commitSubject}
+
+Change-Id: I${changeId}`;
+  return msg;
+};
+function createPublishGerritAction(options) {
+  const { integrations, config } = options;
+  return createTemplateAction({
+    id: "publish:gerrit",
+    description: "Initializes a git repository of the content in the workspace, and publishes it to Gerrit.",
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl"],
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            type: "string"
+          },
+          description: {
+            title: "Repository Description",
+            type: "string"
+          },
+          defaultBranch: {
+            title: "Default Branch",
+            type: "string",
+            description: `Sets the default branch on the repository. The default value is 'master'`
+          },
+          gitCommitMessage: {
+            title: "Git Commit Message",
+            type: "string",
+            description: `Sets the commit message on the repository. The default value is 'initial commit'`
+          },
+          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: {
+          remoteUrl: {
+            title: "A URL to the repository with the provider",
+            type: "string"
+          },
+          repoContentsUrl: {
+            title: "A URL to the root of the repository",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        repoUrl,
+        description,
+        defaultBranch = "master",
+        gitAuthorName,
+        gitAuthorEmail,
+        gitCommitMessage = "initial commit"
+      } = ctx.input;
+      const { repo, host, owner, workspace } = parseRepoUrl(repoUrl, integrations);
+      const integrationConfig = integrations.gerrit.byHost(host);
+      if (!integrationConfig) {
+        throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
+      }
+      if (!owner) {
+        throw new errors.InputError(`Invalid URL provider was included in the repo URL to create ${ctx.input.repoUrl}, missing owner`);
+      }
+      if (!workspace) {
+        throw new errors.InputError(`Invalid URL provider was included in the repo URL to create ${ctx.input.repoUrl}, missing workspace`);
+      }
+      await createGerritProject(integrationConfig.config, {
+        description,
+        owner,
+        projectName: repo,
+        parent: workspace
+      });
+      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 remoteUrl = `${integrationConfig.config.cloneUrl}/a/${repo}`;
+      await initRepoAndPush({
+        dir: getRepoSourceDirectory(ctx.workspacePath, void 0),
+        remoteUrl,
+        auth,
+        defaultBranch,
+        logger: ctx.logger,
+        commitMessage: generateCommitMessage(config, gitCommitMessage),
+        gitAuthorInfo
+      });
+      const repoContentsUrl = `${integrationConfig.config.gitilesBaseUrl}/${repo}/+/refs/heads/${defaultBranch}`;
+      ctx.output("remoteUrl", remoteUrl);
+      ctx.output("repoContentsUrl", repoContentsUrl);
+    }
+  });
+}
+
 const DEFAULT_TIMEOUT_MS = 6e4;
 async function getOctokitOptions(options) {
   var _a;
@@ -1803,7 +1937,16 @@ function createPublishGithubAction(options) {
         allow_squash_merge: allowSquashMerge,
         allow_rebase_merge: allowRebaseMerge
       });
-      const { data: newRepo } = await repoCreationPromise;
+      let newRepo;
+      try {
+        newRepo = (await repoCreationPromise).data;
+      } catch (e) {
+        errors.assertError(e);
+        if (e.message === "Resource not accessible by integration") {
+          ctx.logger.warn(`The GitHub app or token provided may not have the required permissions to create the ${user.data.type} repository ${owner}/${repo}.`);
+        }
+        throw new Error(`Failed to create the ${user.data.type} repository ${owner}/${repo}, ${e.message}`);
+      }
       if (access == null ? void 0 : access.startsWith(`${owner}/`)) {
         const [, team] = access.split("/");
         await client.rest.teams.addOrUpdateRepoPermissionsInOrg({
@@ -2566,6 +2709,10 @@ const createBuiltinActions = (options) => {
       reader,
       additionalTemplateFilters
     }),
+    createPublishGerritAction({
+      integrations,
+      config
+    }),
     createPublishGithubAction({
       integrations,
       config,
@@ -3504,6 +3651,7 @@ exports.createPublishBitbucketAction = createPublishBitbucketAction;
 exports.createPublishBitbucketCloudAction = createPublishBitbucketCloudAction;
 exports.createPublishBitbucketServerAction = createPublishBitbucketServerAction;
 exports.createPublishFileAction = createPublishFileAction;
+exports.createPublishGerritAction = createPublishGerritAction;
 exports.createPublishGithubAction = createPublishGithubAction;
 exports.createPublishGithubPullRequestAction = createPublishGithubPullRequestAction;
 exports.createPublishGitlabAction = createPublishGitlabAction;