@backstage/plugin-scaffolder-backend 0.15.16 → 0.15.20

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # @backstage/plugin-scaffolder-backend
 
+## 0.15.20
+
+### Patch Changes
+
+- 9fbd3b90ae: fix: Register plugin to prioritise Component kind for entityRef
+- 451ef0aa07: Fix token pass-through for software templates using beta 3 version
+- 5333451def: Cleaned up API exports
+- 3b4d8caff6: Allow a GitHubCredentialsProvider to be passed to the GitHub scaffolder tasks actions.
+- Updated dependencies
+  - @backstage/config@0.1.12
+  - @backstage/integration@0.7.1
+  - @backstage/backend-common@0.10.3
+  - @backstage/plugin-catalog-backend@0.20.0
+  - @backstage/errors@0.2.0
+  - @backstage/catalog-client@0.5.4
+  - @backstage/catalog-model@0.9.9
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.1.8
+
+## 0.15.19
+
+### Patch Changes
+
+- 7d4b4e937c: Uptake changes to the GitHub Credentials Provider interface.
+- d078377f67: Support navigating back to pre-filled templates to update inputs of scaffolder tasks for resubmission
+- 5f8ceba1b1: Support custom file name for `catalog:write` action
+- Updated dependencies
+  - @backstage/backend-common@0.10.1
+  - @backstage/plugin-catalog-backend@0.19.4
+  - @backstage/plugin-scaffolder-common@0.1.2
+  - @backstage/integration@0.7.0
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.1.7
+
+## 0.15.18
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.10.0
+  - @backstage/catalog-client@0.5.3
+  - @backstage/plugin-catalog-backend@0.19.3
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.1.6
+
+## 0.15.17
+
+### Patch Changes
+
+- eec0750d8d: Makes cookiecutter a default, but optional action based on if a containerRunner argument is passed in to createRouter or createBuiltinActions
+- ed52f74ab3: Adding changes to create GitLab Merge Request using custom action
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@0.19.2
+  - @backstage/backend-common@0.9.14
+  - @backstage/catalog-model@0.9.8
+
 ## 0.15.16
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -7,6 +7,7 @@ var catalogModel = require('@backstage/catalog-model');
 var fs = require('fs-extra');
 var yaml = require('yaml');
 var backendCommon = require('@backstage/backend-common');
+var integration = require('@backstage/integration');
 var path = require('path');
 var globby = require('globby');
 var isbinaryfile = require('isbinaryfile');
@@ -16,7 +17,6 @@ var child_process = require('child_process');
 var stream = require('stream');
 var azureDevopsNodeApi = require('azure-devops-node-api');
 var fetch = require('node-fetch');
-var integration = require('@backstage/integration');
 var rest = require('@octokit/rest');
 var lodash = require('lodash');
 var octokitPluginCreatePullRequest = require('octokit-plugin-create-pull-request');
@@ -119,7 +119,6 @@ function createCatalogRegisterAction(options) {
       }
     },
     async handler(ctx) {
-      var _a;
       const { input } = ctx;
       let catalogInfoUrl;
       if ("catalogInfoUrl" in input) {
@@ -148,7 +147,14 @@ function createCatalogRegisterAction(options) {
         }, ctx.token ? { token: ctx.token } : {});
         if (result.entities.length > 0) {
           const { entities } = result;
-          const entity = (_a = entities.find((e) => !e.metadata.name.startsWith("generated-"))) != null ? _a : entities[0];
+          let entity;
+          entity = entities.find((e) => !e.metadata.name.startsWith("generated-") && e.kind === "Component");
+          if (!entity) {
+            entity = entities.find((e) => !e.metadata.name.startsWith("generated-"));
+          }
+          if (!entity) {
+            entity = entities[0];
+          }
           ctx.output("entityRef", catalogModel.stringifyEntityRef(entity));
         }
       } catch (e) {
@@ -169,6 +175,11 @@ function createCatalogWriteAction() {
       input: {
         type: "object",
         properties: {
+          filePath: {
+            title: "Catalog file path",
+            description: "Defaults to catalog-info.yaml",
+            type: "string"
+          },
           entity: {
             title: "Entity info to write catalog-info.yaml",
             description: "You can provide the same values used in the Entity schema.",
@@ -179,8 +190,9 @@ function createCatalogWriteAction() {
     },
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
-      const { entity } = ctx.input;
-      await fs__default["default"].writeFile(backendCommon.resolveSafeChildPath(ctx.workspacePath, "catalog-info.yaml"), yaml__namespace.stringify(entity));
+      const { filePath, entity } = ctx.input;
+      const path = filePath != null ? filePath : "catalog-info.yaml";
+      await fs__default["default"].writeFile(backendCommon.resolveSafeChildPath(ctx.workspacePath, path), yaml__namespace.stringify(entity));
     }
   });
 }
@@ -1144,12 +1156,9 @@ function createPublishFileAction() {
 }
 
 class OctokitProvider {
-  constructor(integrations) {
+  constructor(integrations, githubCredentialsProvider) {
     this.integrations = integrations;
-    this.credentialsProviders = new Map(integrations.github.list().map((integration$1) => {
-      const provider = integration.GithubCredentialsProvider.create(integration$1.config);
-      return [integration$1.config.host, provider];
-    }));
+    this.githubCredentialsProvider = githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
   }
   async getOctokit(repoUrl) {
     var _a;
@@ -1161,11 +1170,7 @@ class OctokitProvider {
     if (!integrationConfig) {
       throw new errors.InputError(`No integration for host ${host}`);
     }
-    const credentialsProvider = this.credentialsProviders.get(host);
-    if (!credentialsProvider) {
-      throw new errors.InputError(`No matching credentials for host ${host}, please check your integrations config`);
-    }
-    const { token } = await credentialsProvider.getCredentials({
+    const { token } = await this.githubCredentialsProvider.getCredentials({
       url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`
     });
     if (!token) {
@@ -1181,8 +1186,8 @@ class OctokitProvider {
 }
 
 function createPublishGithubAction(options) {
-  const { integrations, config } = options;
-  const octokitProvider = new OctokitProvider(integrations);
+  const { integrations, config, githubCredentialsProvider } = options;
+  const octokitProvider = new OctokitProvider(integrations, githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations));
   return createTemplateAction({
     id: "publish:github",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
@@ -1382,6 +1387,7 @@ class GithubResponseError extends errors.CustomErrorBase {
 }
 const defaultClientFactory = async ({
   integrations,
+  githubCredentialsProvider,
   owner,
   repo,
   host = "github.com"
@@ -1391,10 +1397,7 @@ const defaultClientFactory = async ({
   if (!integrationConfig) {
     throw new errors.InputError(`No integration for host ${host}`);
   }
-  const credentialsProvider = integration.GithubCredentialsProvider.create(integrationConfig);
-  if (!credentialsProvider) {
-    throw new errors.InputError(`No matching credentials for host ${host}, please check your integrations config`);
-  }
+  const credentialsProvider = githubCredentialsProvider || integration.SingleInstanceGithubCredentialsProvider.create(integrationConfig);
   const { token } = await credentialsProvider.getCredentials({
     url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`
   });
@@ -1409,6 +1412,7 @@ const defaultClientFactory = async ({
 };
 const createPublishGithubPullRequestAction = ({
   integrations,
+  githubCredentialsProvider,
   clientFactory = defaultClientFactory
 }) => {
   return createTemplateAction({
@@ -1475,7 +1479,13 @@ const createPublishGithubPullRequestAction = ({
       if (!owner) {
         throw new errors.InputError(`No owner provided for host: ${host}, and repo ${repo}`);
       }
-      const client = await clientFactory({ integrations, host, owner, repo });
+      const client = await clientFactory({
+        integrations,
+        githubCredentialsProvider,
+        host,
+        owner,
+        repo
+      });
       const fileRoot = sourcePath ? backendCommon.resolveSafeChildPath(ctx.workspacePath, sourcePath) : ctx.workspacePath;
       const localFilePaths = await globby__default["default"](["./**", "./**/.*", "!.git"], {
         cwd: fileRoot,
@@ -1622,9 +1632,123 @@ function createPublishGitlabAction(options) {
   });
 }
 
-function createGithubActionsDispatchAction(options) {
+const createPublishGitlabMergeRequestAction = (options) => {
   const { integrations } = options;
-  const octokitProvider = new OctokitProvider(integrations);
+  return createTemplateAction({
+    id: "publish:gitlab:merge-request",
+    schema: {
+      input: {
+        required: ["projectid", "repoUrl", "targetPath", "branchName"],
+        type: "object",
+        properties: {
+          repoUrl: {
+            type: "string",
+            title: "Repository Location",
+            description: `Accepts the format 'gitlab.com/group_name/project_name' where 'project_name' is the repository name and 'group_name' is a group or username`
+          },
+          projectid: {
+            type: "string",
+            title: "projectid",
+            description: "Project ID/Name(slug) of the Gitlab Project"
+          },
+          title: {
+            type: "string",
+            title: "Merge Request Name",
+            description: "The name for the merge request"
+          },
+          description: {
+            type: "string",
+            title: "Merge Request Description",
+            description: "The description of the merge request"
+          },
+          branchName: {
+            type: "string",
+            title: "Destination Branch name",
+            description: "The description of the merge request"
+          },
+          targetPath: {
+            type: "string",
+            title: "Repository Subdirectory",
+            description: "Subdirectory of repository to apply changes to"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          projectid: {
+            title: "Gitlab Project id/Name(slug)",
+            type: "string"
+          },
+          mergeRequestURL: {
+            title: "MergeRequest(MR) URL",
+            type: "string",
+            description: "Link to the merge request in GitLab"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const repoUrl = ctx.input.repoUrl;
+      const { host } = parseRepoUrl(repoUrl, integrations);
+      const integrationConfig = integrations.gitlab.byHost(host);
+      const actions = [];
+      const destinationBranch = ctx.input.branchName;
+      if (!integrationConfig) {
+        throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
+      }
+      if (!integrationConfig.config.token) {
+        throw new errors.InputError(`No token available for host ${host}`);
+      }
+      const api = new node.Gitlab({
+        host: integrationConfig.config.baseUrl,
+        token: integrationConfig.config.token
+      });
+      const fileRoot = ctx.workspacePath;
+      const localFilePaths = await globby__default["default"]([`${ctx.input.targetPath}/**`], {
+        cwd: fileRoot,
+        gitignore: true,
+        dot: true
+      });
+      const fileContents = await Promise.all(localFilePaths.map((p) => fs.readFile(backendCommon.resolveSafeChildPath(fileRoot, p))));
+      const repoFilePaths = localFilePaths.map((repoFilePath) => {
+        return repoFilePath;
+      });
+      for (let i = 0; i < repoFilePaths.length; i++) {
+        actions.push({
+          action: "create",
+          filePath: repoFilePaths[i],
+          content: fileContents[i].toString()
+        });
+      }
+      const projects = await api.Projects.show(ctx.input.projectid);
+      const { default_branch: defaultBranch } = projects;
+      try {
+        await api.Branches.create(ctx.input.projectid, destinationBranch, String(defaultBranch));
+      } catch (e) {
+        throw new errors.InputError(`The branch creation failed ${e}`);
+      }
+      try {
+        await api.Commits.create(ctx.input.projectid, destinationBranch, ctx.input.title, actions);
+      } catch (e) {
+        throw new errors.InputError(`Committing the changes to ${destinationBranch} failed ${e}`);
+      }
+      try {
+        const mergeRequestUrl = await api.MergeRequests.create(ctx.input.projectid, destinationBranch, String(defaultBranch), ctx.input.title, { description: ctx.input.description }).then((mergeRequest) => {
+          return mergeRequest.web_url;
+        });
+        ctx.output("projectid", ctx.input.projectid);
+        ctx.output("mergeRequestUrl", mergeRequestUrl);
+      } catch (e) {
+        throw new errors.InputError(`Merge request creation failed${e}`);
+      }
+    }
+  });
+};
+
+function createGithubActionsDispatchAction(options) {
+  const { integrations, githubCredentialsProvider } = options;
+  const octokitProvider = new OctokitProvider(integrations, githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations));
   return createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
@@ -1667,8 +1791,8 @@ function createGithubActionsDispatchAction(options) {
 }
 
 function createGithubWebhookAction(options) {
-  const { integrations, defaultWebhookSecret } = options;
-  const octokitProvider = new OctokitProvider(integrations);
+  const { integrations, defaultWebhookSecret, githubCredentialsProvider } = options;
+  const octokitProvider = new OctokitProvider(integrations, githubCredentialsProvider != null ? githubCredentialsProvider : integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations));
   const eventNames = webhooks.emitterEventNames.filter((event) => !event.includes("."));
   return createTemplateAction({
     id: "github:webhook",
@@ -1768,31 +1892,32 @@ function createGithubWebhookAction(options) {
 
 const createBuiltinActions = (options) => {
   const { reader, integrations, containerRunner, catalogClient, config } = options;
-  return [
+  const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
+  const actions = [
     createFetchPlainAction({
       reader,
       integrations
     }),
-    pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction({
-      reader,
-      integrations,
-      containerRunner
-    }),
     createFetchTemplateAction({
       integrations,
       reader
     }),
     createPublishGithubAction({
       integrations,
-      config
+      config,
+      githubCredentialsProvider
     }),
     createPublishGithubPullRequestAction({
-      integrations
+      integrations,
+      githubCredentialsProvider
     }),
     createPublishGitlabAction({
       integrations,
       config
     }),
+    createPublishGitlabMergeRequestAction({
+      integrations
+    }),
     createPublishBitbucketAction({
       integrations,
       config
@@ -1807,12 +1932,22 @@ const createBuiltinActions = (options) => {
     createFilesystemDeleteAction(),
     createFilesystemRenameAction(),
     createGithubActionsDispatchAction({
-      integrations
+      integrations,
+      githubCredentialsProvider
     }),
     createGithubWebhookAction({
-      integrations
+      integrations,
+      githubCredentialsProvider
     })
   ];
+  if (containerRunner) {
+    actions.push(pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction({
+      reader,
+      integrations,
+      containerRunner
+    }));
+  }
+  return actions;
 };
 
 class TemplateActionRegistry {
@@ -2395,7 +2530,7 @@ class NunjucksWorkflowRunner {
     });
   }
   async execute(task) {
-    var _a, _b;
+    var _a, _b, _c;
     if (!isValidTaskSpec(task.spec)) {
       throw new errors.InputError("Wrong template version executed with the workflow engine");
     }
@@ -2444,6 +2579,7 @@ class NunjucksWorkflowRunner {
           await action.handler({
             baseUrl: task.spec.baseUrl,
             input,
+            token: (_c = task.secrets) == null ? void 0 : _c.token,
             logger: taskLogger,
             logStream: streamLogger,
             workspacePath,
@@ -2875,6 +3011,7 @@ exports.createPublishFileAction = createPublishFileAction;
 exports.createPublishGithubAction = createPublishGithubAction;
 exports.createPublishGithubPullRequestAction = createPublishGithubPullRequestAction;
 exports.createPublishGitlabAction = createPublishGitlabAction;
+exports.createPublishGitlabMergeRequestAction = createPublishGitlabMergeRequestAction;
 exports.createRouter = createRouter;
 exports.createTemplateAction = createTemplateAction;
 exports.fetchContents = fetchContents;