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

package/CHANGELOG.md

@@ -1,5 +1,74 @@
 # @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
+
+- 9818112d12: Update the `github:publish` action to allow passing required status check
+  contexts before merging to the main branch.
+- f8baf7df44: Added the ability to reference the user in the `template.yaml` manifest
+- 8d5a2238a9: Split `publish:bitbucket` into `publish:bitbucketCloud` and `publish:bitbucketServer`.
+
+  In order to migrate from the deprecated action, you need to replace the use of action
+  `publish:bitbucket` in your templates with the use of either `publish:bitbucketCloud`
+  or `publish:bitbucketServer` - depending on which destination SCM provider you use.
+
+  Additionally, these actions will not utilize `integrations.bitbucket` anymore,
+  but `integrations.bitbucketCloud` or `integrations.bitbucketServer` respectively.
+  You may or may not have migrated to these already.
+
+  As described in a previous changeset, using these two replacement integrations configs
+  will not compromise use cases which still rely on `integrations.bitbucket` as this was
+  set up in a backwards compatible way.
+
+  Additionally, please mind that the option `enableLFS` is only available (and always was)
+  for Bitbucket Server use cases and therefore, is not even part of the schema for
+  `publish:bitbucketCloud` anymore.
+
+### Patch Changes
+
+- 0fc65cbf89: Override default commit message and author details in GitHub, Azure, bitbucket
+- cfc0f19699: Updated dependency `fs-extra` to `10.1.0`.
+- Updated dependencies
+  - @backstage/backend-common@0.13.3
+  - @backstage/plugin-catalog-backend@1.1.2
+  - @backstage/integration@1.2.0
+  - @backstage/plugin-scaffolder-common@1.1.0
+  - @backstage/config@1.0.1
+  - @backstage/catalog-client@1.0.2
+  - @backstage/catalog-model@1.0.2
+
+## 1.2.0-next.1
+
+### Minor Changes
+
+- f8baf7df44: Added the ability to reference the user in the `template.yaml` manifest
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.13.3-next.2
+  - @backstage/plugin-catalog-backend@1.1.2-next.2
+  - @backstage/plugin-scaffolder-common@1.1.0-next.0
+  - @backstage/config@1.0.1-next.0
+  - @backstage/catalog-model@1.0.2-next.0
+  - @backstage/integration@1.2.0-next.1
+  - @backstage/catalog-client@1.0.2-next.0
+
 ## 1.2.0-next.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,
@@ -2653,6 +2800,7 @@ class DatabaseTaskStore {
     this.db = options.database;
   }
   async getTask(taskId) {
+    var _a;
     const [result] = await this.db("tasks").where({ id: taskId }).select();
     if (!result) {
       throw new errors.NotFoundError(`No task with id '${taskId}' found`);
@@ -2666,6 +2814,7 @@ class DatabaseTaskStore {
         status: result.status,
         lastHeartbeatAt: result.last_heartbeat_at,
         createdAt: result.created_at,
+        createdBy: (_a = result.created_by) != null ? _a : void 0,
         secrets
       };
     } catch (error) {
@@ -2673,17 +2822,20 @@ class DatabaseTaskStore {
     }
   }
   async createTask(options) {
+    var _a;
     const taskId = uuid.v4();
     await this.db("tasks").insert({
       id: taskId,
       spec: JSON.stringify(options.spec),
       secrets: options.secrets ? JSON.stringify(options.secrets) : void 0,
+      created_by: (_a = options.createdBy) != null ? _a : null,
       status: "open"
     });
     return { taskId };
   }
   async claimTask() {
     return this.db.transaction(async (tx) => {
+      var _a;
       const [task] = await tx("tasks").where({
         status: "open"
       }).limit(1).select();
@@ -2707,6 +2859,7 @@ class DatabaseTaskStore {
           status: "processing",
           lastHeartbeatAt: task.last_heartbeat_at,
           createdAt: task.created_at,
+          createdBy: (_a = task.created_by) != null ? _a : void 0,
           secrets
         };
       } catch (error) {
@@ -2825,6 +2978,9 @@ class TaskManager {
   get secrets() {
     return this.task.secrets;
   }
+  get createdBy() {
+    return this.task.createdBy;
+  }
   async getWorkspaceName() {
     return this.task.taskId;
   }
@@ -2884,7 +3040,8 @@ class StorageTaskBroker {
         return TaskManager.create({
           taskId: pendingTask.id,
           spec: pendingTask.spec,
-          secrets: pendingTask.secrets
+          secrets: pendingTask.secrets,
+          createdBy: pendingTask.createdBy
         }, this.storage, this.logger);
       }
       await this.waitForDispatch();
@@ -3035,7 +3192,8 @@ class NunjucksWorkflowRunner {
       await task.emitLog(`Starting up task with ${task.spec.steps.length} steps`);
       const context = {
         parameters: task.spec.parameters,
-        steps: {}
+        steps: {},
+        user: task.spec.user
       };
       for (const step of task.spec.steps) {
         try {
@@ -3253,10 +3411,11 @@ async function createRouter(options) {
   router.get("/v2/templates/:namespace/:kind/:name/parameter-schema", async (req, res) => {
     var _a, _b;
     const { namespace, kind, name } = req.params;
+    const { token } = parseBearerToken(req.headers.authorization);
     const template = await findTemplate({
       catalogApi: catalogClient,
       entityRef: { kind, namespace, name },
-      token: getBearerToken(req.headers.authorization)
+      token
     });
     if (isSupportedTemplate(template)) {
       const parameters = [(_a = template.spec.parameters) != null ? _a : []].flat();
@@ -3288,12 +3447,13 @@ async function createRouter(options) {
     const { kind, namespace, name } = catalogModel.parseEntityRef(templateRef, {
       defaultKind: "template"
     });
+    const { token, entityRef: userEntityRef } = parseBearerToken(req.headers.authorization);
+    const userEntity = userEntityRef ? await catalogClient.getEntityByRef(userEntityRef, { token }) : void 0;
     const values = req.body.values;
-    const token = getBearerToken(req.headers.authorization);
     const template = await findTemplate({
       catalogApi: catalogClient,
       entityRef: { kind, namespace, name },
-      token: getBearerToken(req.headers.authorization)
+      token
     });
     if (!isSupportedTemplate(template)) {
       throw new errors.InputError(`Unsupported apiVersion field in schema entity, ${template.apiVersion}`);
@@ -3318,6 +3478,10 @@ async function createRouter(options) {
       }),
       output: (_b = template.spec.output) != null ? _b : {},
       parameters: values,
+      user: {
+        entity: userEntity,
+        ref: userEntityRef
+      },
       templateInfo: {
         entityRef: catalogModel.stringifyEntityRef({
           kind,
@@ -3329,6 +3493,7 @@ async function createRouter(options) {
     };
     const result = await taskBroker.dispatch({
       spec: taskSpec,
+      createdBy: userEntityRef,
       secrets: {
         ...req.body.secrets,
         backstageToken: token
@@ -3403,9 +3568,17 @@ data: ${JSON.stringify(event)}
   app.use("/", router);
   return app;
 }
-function getBearerToken(header) {
+function parseBearerToken(header) {
   var _a;
-  return (_a = header == null ? void 0 : header.match(/Bearer\s+(\S+)/i)) == null ? void 0 : _a[1];
+  const token = (_a = header == null ? void 0 : header.match(/Bearer\s+(\S+)/i)) == null ? void 0 : _a[1];
+  if (!token)
+    return {};
+  const [_header, rawPayload, _signature] = token.split(".");
+  const payload = JSON.parse(Buffer.from(rawPayload, "base64").toString());
+  return {
+    entityRef: payload.sub,
+    token
+  };
 }
 
 class ScaffolderEntitiesProcessor {
@@ -3478,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;