@backstage/plugin-scaffolder-backend 0.15.2 → 0.15.6

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @backstage/plugin-scaffolder-backend
 
+## 0.15.6
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@0.6.5
+  - @backstage/catalog-client@0.4.0
+  - @backstage/catalog-model@0.9.3
+  - @backstage/backend-common@0.9.4
+  - @backstage/config@0.1.10
+
+## 0.15.5
+
+### Patch Changes
+
+- 618143c3c7: Action needed: If you are using the templates located at https://github.com/backstage/backstage/tree/master/ in your Backstage app directly using the URL via the `app-config.yaml`, you should copy over the templates inside your org and import from there. The templates have now been moved to https://github.com/backstage/software-templates. See https://github.com/backstage/backstage/issues/6415 for explanation.
+- cfade02127: Change hardcoded branch `master` to \$defaultBranch in GitLab provider
+- 96fef17a18: Upgrade git-parse-url to v11.6.0
+- Updated dependencies
+  - @backstage/backend-common@0.9.3
+  - @backstage/integration@0.6.4
+
+## 0.15.4
+
+### Patch Changes
+
+- 04aad2dab: Fix issue #7021 scaffolder action fetch:template preserves templates file permissions
+- 21ccd4997: GitHub Webhook action in Scaffolder Backend has been improved to validate event names against Octokit Webhook event names list.
+- Updated dependencies
+  - @backstage/catalog-client@0.3.19
+  - @backstage/catalog-model@0.9.2
+  - @backstage/errors@0.1.2
+  - @backstage/config@0.1.9
+  - @backstage/backend-common@0.9.2
+
+## 0.15.3
+
+### Patch Changes
+
+- 3f9dd1759: GitHub create repository webhook action: `github:webhook` for Backstage plugin Scaffolder has been added.
+- 774b08a5c: GitHubWebhook Action can be created with a default webhook secret. This allows getting secret from environment variable as an alternative to get it from context.
+- 536f4d844: Updated dependencies
+- 0b92a1e74: refactor: extract common Octokit related code and use it in actions: `publish:github`, `github:actions:dispatch`, `github:webhook`.
+- Updated dependencies
+  - @backstage/integration@0.6.3
+  - @backstage/catalog-model@0.9.1
+  - @backstage/backend-common@0.9.1
+
 ## 0.15.2
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -21,6 +21,7 @@ var rest = require('@octokit/rest');
 var lodash = require('lodash');
 var octokitPluginCreatePullRequest = require('octokit-plugin-create-pull-request');
 var node = require('@gitbeaker/node');
+var webhooks = require('@octokit/webhooks');
 var express = require('express');
 var Router = require('express-promise-router');
 var jsonschema = require('jsonschema');
@@ -418,9 +419,10 @@ function createFetchTemplateAction(options) {
             ctx.logger.info(`Copying binary file ${location} to template output path.`);
             await fs__default['default'].copy(inputFilePath, outputPath);
           } else {
-            ctx.logger.info(`Writing file ${location} to template output path.`);
+            const statsObj = await fs__default['default'].stat(inputFilePath);
+            ctx.logger.info(`Writing file ${location} to template output path with mode ${statsObj.mode}.`);
             const inputFileContents = await fs__default['default'].readFile(inputFilePath, "utf-8");
-            await fs__default['default'].outputFile(outputPath, renderContents ? templater.renderString(inputFileContents, context) : inputFileContents);
+            await fs__default['default'].outputFile(outputPath, renderContents ? templater.renderString(inputFileContents, context) : inputFileContents, {mode: statsObj.mode});
           }
         }
       }
@@ -1018,12 +1020,46 @@ function createPublishFileAction() {
   });
 }
 
+class OctokitProvider {
+  constructor(integrations) {
+    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];
+    }));
+  }
+  async getOctokit(repoUrl) {
+    var _a;
+    const {owner, repo, host} = parseRepoUrl(repoUrl, this.integrations);
+    if (!owner) {
+      throw new errors.InputError(`No owner provided for repo ${repoUrl}`);
+    }
+    const integrationConfig = (_a = this.integrations.github.byHost(host)) == null ? void 0 : _a.config;
+    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({
+      url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`
+    });
+    if (!token) {
+      throw new errors.InputError(`No token available for host: ${host}, with owner ${owner}, and repo ${repo}`);
+    }
+    const client = new rest.Octokit({
+      auth: token,
+      baseUrl: integrationConfig.apiBaseUrl,
+      previews: ["nebula-preview"]
+    });
+    return {client, token, owner, repo};
+  }
+}
+
 function createPublishGithubAction(options) {
   const {integrations, config} = options;
-  const credentialsProviders = new Map(integrations.github.list().map((integration$1) => {
-    const provider = integration.GithubCredentialsProvider.create(integration$1.config);
-    return [integration$1.config.host, provider];
-  }));
+  const octokitProvider = new OctokitProvider(integrations);
   return createTemplateAction({
     id: "publish:github",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
@@ -1118,26 +1154,7 @@ function createPublishGithubAction(options) {
         collaborators,
         topics
       } = ctx.input;
-      const {owner, repo, host} = parseRepoUrl(repoUrl, integrations);
-      if (!owner) {
-        throw new errors.InputError(`No owner provided for host: ${host}, and repo ${repo}`);
-      }
-      const credentialsProvider = credentialsProviders.get(host);
-      const integrationConfig = integrations.github.byHost(host);
-      if (!credentialsProvider || !integrationConfig) {
-        throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
-      }
-      const {token} = await credentialsProvider.getCredentials({
-        url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`
-      });
-      if (!token) {
-        throw new errors.InputError(`No token available for host: ${host}, with owner ${owner}, and repo ${repo}`);
-      }
-      const client = new rest.Octokit({
-        auth: token,
-        baseUrl: integrationConfig.config.apiBaseUrl,
-        previews: ["nebula-preview"]
-      });
+      const {client, token, owner, repo} = await octokitProvider.getOctokit(repoUrl);
       const user = await client.users.getByUsername({
         username: owner
       });
@@ -1445,7 +1462,7 @@ function createPublishGitlabAction(options) {
         visibility: repoVisibility
       });
       const remoteUrl = http_url_to_repo.replace(/\.git$/, "");
-      const repoContentsUrl = `${remoteUrl}/-/blob/master`;
+      const repoContentsUrl = `${remoteUrl}/-/blob/${defaultBranch}`;
       const gitAuthorInfo = {
         name: config.getOptionalString("scaffolder.defaultAuthor.name"),
         email: config.getOptionalString("scaffolder.defaultAuthor.email")
@@ -1470,10 +1487,7 @@ function createPublishGitlabAction(options) {
 
 function createGithubActionsDispatchAction(options) {
   const {integrations} = options;
-  const credentialsProviders = new Map(integrations.github.list().map((integration$1) => {
-    const provider = integration.GithubCredentialsProvider.create(integration$1.config);
-    return [integration$1.config.host, provider];
-  }));
+  const octokitProvider = new OctokitProvider(integrations);
   return createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
@@ -1502,27 +1516,8 @@ function createGithubActionsDispatchAction(options) {
     },
     async handler(ctx) {
       const {repoUrl, workflowId, branchOrTagName} = ctx.input;
-      const {owner, repo, host} = parseRepoUrl(repoUrl, integrations);
-      if (!owner) {
-        throw new errors.InputError(`No owner provided for host: ${host}, and repo ${repo}`);
-      }
       ctx.logger.info(`Dispatching workflow ${workflowId} for repo ${repoUrl} on ${branchOrTagName}`);
-      const credentialsProvider = credentialsProviders.get(host);
-      const integrationConfig = integrations.github.byHost(host);
-      if (!credentialsProvider || !integrationConfig) {
-        throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
-      }
-      const {token} = await credentialsProvider.getCredentials({
-        url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`
-      });
-      if (!token) {
-        throw new errors.InputError(`No token available for host: ${host}, with owner ${owner}, and repo ${repo}`);
-      }
-      const client = new rest.Octokit({
-        auth: token,
-        baseUrl: integrationConfig.config.apiBaseUrl,
-        previews: ["nebula-preview"]
-      });
+      const {client, owner, repo} = await octokitProvider.getOctokit(repoUrl);
       await client.rest.actions.createWorkflowDispatch({
         owner,
         repo,
@@ -1534,6 +1529,105 @@ function createGithubActionsDispatchAction(options) {
   });
 }
 
+function createGithubWebhookAction(options) {
+  const {integrations, defaultWebhookSecret} = options;
+  const octokitProvider = new OctokitProvider(integrations);
+  const eventNames = webhooks.emitterEventNames.filter((event) => !event.includes("."));
+  return createTemplateAction({
+    id: "github:webhook",
+    description: "Creates webhook for a repository on GitHub.",
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl", "webhookUrl"],
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the new repository name and 'owner' is an organization or username`,
+            type: "string"
+          },
+          webhookUrl: {
+            title: "Webhook URL",
+            description: "The URL to which the payloads will be delivered",
+            type: "string"
+          },
+          webhookSecret: {
+            title: "Webhook Secret",
+            description: "Webhook secret value. The default can be provided internally in action creation",
+            type: "string"
+          },
+          events: {
+            title: "Triggering Events",
+            description: "Determines what events the hook is triggered for. Default: push",
+            type: "array",
+            oneOf: [
+              {
+                items: {
+                  type: "string",
+                  enum: eventNames
+                }
+              },
+              {
+                items: {
+                  type: "string",
+                  const: "*"
+                }
+              }
+            ]
+          },
+          active: {
+            title: "Active",
+            type: "boolean",
+            description: `Determines if notifications are sent when the webhook is triggered. Default: true`
+          },
+          contentType: {
+            title: "Content Type",
+            type: "string",
+            enum: ["form", "json"],
+            description: `The media type used to serialize the payloads. The default is 'form'`
+          },
+          insecureSsl: {
+            title: "Insecure SSL",
+            type: "boolean",
+            description: `Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default 'false'`
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        repoUrl,
+        webhookUrl,
+        webhookSecret = defaultWebhookSecret,
+        events = ["push"],
+        active = true,
+        contentType = "form",
+        insecureSsl = false
+      } = ctx.input;
+      ctx.logger.info(`Creating webhook ${webhookUrl} for repo ${repoUrl}`);
+      const {client, owner, repo} = await octokitProvider.getOctokit(repoUrl);
+      try {
+        const insecure_ssl = insecureSsl ? "1" : "0";
+        await client.repos.createWebhook({
+          owner,
+          repo,
+          config: {
+            url: webhookUrl,
+            content_type: contentType,
+            secret: webhookSecret,
+            insecure_ssl
+          },
+          events,
+          active
+        });
+        ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);
+      } catch (e) {
+        ctx.logger.warn(`Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${e.message}`);
+      }
+    }
+  });
+}
+
 const createBuiltinActions = (options) => {
   const {reader, integrations, containerRunner, catalogClient, config} = options;
   return [
@@ -1576,6 +1670,9 @@ const createBuiltinActions = (options) => {
     createFilesystemRenameAction(),
     createGithubActionsDispatchAction({
       integrations
+    }),
+    createGithubWebhookAction({
+      integrations
     })
   ];
 };
@@ -2324,6 +2421,7 @@ Object.defineProperty(exports, 'createFetchCookiecutterAction', {
   }
 });
 exports.CatalogEntityClient = CatalogEntityClient;
+exports.OctokitProvider = OctokitProvider;
 exports.TemplateActionRegistry = TemplateActionRegistry;
 exports.createBuiltinActions = createBuiltinActions;
 exports.createCatalogRegisterAction = createCatalogRegisterAction;
@@ -2334,6 +2432,7 @@ exports.createFetchTemplateAction = createFetchTemplateAction;
 exports.createFilesystemDeleteAction = createFilesystemDeleteAction;
 exports.createFilesystemRenameAction = createFilesystemRenameAction;
 exports.createGithubActionsDispatchAction = createGithubActionsDispatchAction;
+exports.createGithubWebhookAction = createGithubWebhookAction;
 exports.createPublishAzureAction = createPublishAzureAction;
 exports.createPublishBitbucketAction = createPublishBitbucketAction;
 exports.createPublishFileAction = createPublishFileAction;