@backstage/plugin-scaffolder-backend 0.0.0-nightly-20220301023335 → 0.0.0-nightly-20220305022735

package/CHANGELOG.md

@@ -1,17 +1,47 @@
 # @backstage/plugin-scaffolder-backend
 
-## 0.0.0-nightly-20220301023335
+## 0.0.0-nightly-20220305022735
+
+### Minor Changes
+
+- f9c7bdd899: **BREAKING**:
+
+  - Removed the `createFetchCookiecutterAction` export, please use the `@backstage/plugin-scaffolder-backend-module-cookiecutter` package explicitly (see [its README](https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend-module-cookiecutter) for installation instructions).
+  - Removed the `containerRunner` argument from the types `RouterOptions` (as used by `createRouter`) and `CreateBuiltInActionsOptions` (as used by `createBuiltinActions`).
+
+- 5afbd16d43: **BREAKING**: Removed the previously deprecated `OctokitProvider` class.
+
+### Patch Changes
+
+- 458d16869c: Allow passing more repo configuration for `publish:github` action
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220305022735
+  - @backstage/catalog-model@0.0.0-nightly-20220305022735
+  - @backstage/backend-common@0.0.0-nightly-20220305022735
+  - @backstage/catalog-client@0.0.0-nightly-20220305022735
+  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220305022735
+
+## 0.17.3
 
 ### Patch Changes
 
 - 5c7f2343ea: Applied fix from version 0.17.2 of this package, which is part of the v0.69.2 release of Backstage.
+- 899f196af5: Use `getEntityByRef` instead of `getEntityByName` in the catalog client
+- 34af86517c: ensure `apiBaseUrl` being set for Bitbucket integrations, replace hardcoded defaults
 - d6deb5e440: Set timeout for scaffolder octokit client
+- 83a83381b0: Use the new `processingResult` export from the catalog backend
 - 7372f29473: Cleanup API report
 - c7f6424a26: Applied fix from `v0.17.1` of this package which is part of the `v0.69.1` release of Backstage.
+- 36aa63022b: Use `CompoundEntityRef` instead of `EntityName`, and `getCompoundEntityRef` instead of `getEntityName`, from `@backstage/catalog-model`.
 - 8119a9e011: Fix the support for custom defaultBranch values for Bitbucket Cloud at the `publish:bitbucket` scaffolder action.
 - Updated dependencies
-  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220301023335
-  - @backstage/integration@0.0.0-nightly-20220301023335
+  - @backstage/catalog-model@0.12.0
+  - @backstage/catalog-client@0.8.0
+  - @backstage/plugin-catalog-backend@0.23.0
+  - @backstage/backend-common@0.12.0
+  - @backstage/integration@0.8.0
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.2.3
+  - @backstage/plugin-scaffolder-common@0.2.3
 
 ## 0.17.2
 

package/dist/index.cjs.js

@@ -12,7 +12,6 @@ var path = require('path');
 var globby = require('globby');
 var isbinaryfile = require('isbinaryfile');
 var vm2 = require('vm2');
-var pluginScaffolderBackendModuleCookiecutter = require('@backstage/plugin-scaffolder-backend-module-cookiecutter');
 var child_process = require('child_process');
 var stream = require('stream');
 var azureDevopsNodeApi = require('azure-devops-node-api');
@@ -939,7 +938,8 @@ const createBitbucketCloudRepository = async (opts) => {
     description,
     repoVisibility,
     mainBranch,
-    authorization
+    authorization,
+    apiBaseUrl
   } = opts;
   const options = {
     method: "POST",
@@ -956,7 +956,7 @@ const createBitbucketCloudRepository = async (opts) => {
   };
   let response;
   try {
-    response = await fetch__default["default"](`https://api.bitbucket.org/2.0/repositories/${workspace}/${repo}`, options);
+    response = await fetch__default["default"](`${apiBaseUrl}/repositories/${workspace}/${repo}`, options);
   } catch (e) {
     throw new Error(`Unable to create repository, ${e}`);
   }
@@ -975,7 +975,6 @@ const createBitbucketCloudRepository = async (opts) => {
 };
 const createBitbucketServerRepository = async (opts) => {
   const {
-    host,
     project,
     repo,
     description,
@@ -997,8 +996,7 @@ const createBitbucketServerRepository = async (opts) => {
     }
   };
   try {
-    const baseUrl = apiBaseUrl ? apiBaseUrl : `https://${host}/rest/api/1.0`;
-    response = await fetch__default["default"](`${baseUrl}/projects/${project}/repos`, options);
+    response = await fetch__default["default"](`${apiBaseUrl}/projects/${project}/repos`, options);
   } catch (e) {
     throw new Error(`Unable to create repository, ${e}`);
   }
@@ -1118,12 +1116,15 @@ function createPublishBitbucketAction(options) {
       if (!integrationConfig) {
         throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
       }
-      const authorization = getAuthorizationHeader(ctx.input.token ? { host: integrationConfig.config.host, token: ctx.input.token } : integrationConfig.config);
+      const authorization = getAuthorizationHeader(ctx.input.token ? {
+        host: integrationConfig.config.host,
+        apiBaseUrl: integrationConfig.config.apiBaseUrl,
+        token: ctx.input.token
+      } : integrationConfig.config);
       const apiBaseUrl = integrationConfig.config.apiBaseUrl;
       const createMethod = host === "bitbucket.org" ? createBitbucketCloudRepository : createBitbucketServerRepository;
       const { remoteUrl, repoContentsUrl } = await createMethod({
         authorization,
-        host,
         workspace: workspace || "",
         project,
         repo,
@@ -1270,6 +1271,26 @@ function createPublishGithubAction(options) {
             type: "string",
             description: `Sets the default branch on the repository. The default value is 'master'`
           },
+          deleteBranchOnMerge: {
+            title: "Delete Branch On Merge",
+            type: "boolean",
+            description: `Delete the branch after merging the PR. The default value is 'false'`
+          },
+          allowMergeCommit: {
+            title: "Allow Merge Commits",
+            type: "boolean",
+            description: `Allow merge commits. The default value is 'true'`
+          },
+          allowSquashMerge: {
+            title: "Allow Squash Merges",
+            type: "boolean",
+            description: `Allow squash merges. The default value is 'true'`
+          },
+          allowRebaseMerge: {
+            title: "Allow Rebase Merges",
+            type: "boolean",
+            description: `Allow rebase merges. The default value is 'true'`
+          },
           sourcePath: {
             title: "Source Path",
             description: "Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository.",
@@ -1331,6 +1352,10 @@ function createPublishGithubAction(options) {
         requireCodeOwnerReviews = false,
         repoVisibility = "private",
         defaultBranch = "master",
+        deleteBranchOnMerge = false,
+        allowMergeCommit = true,
+        allowSquashMerge = true,
+        allowRebaseMerge = true,
         collaborators,
         topics,
         token: providedToken
@@ -1354,11 +1379,19 @@ function createPublishGithubAction(options) {
         org: owner,
         private: repoVisibility === "private",
         visibility: repoVisibility,
-        description
+        description,
+        delete_branch_on_merge: deleteBranchOnMerge,
+        allow_merge_commit: allowMergeCommit,
+        allow_squash_merge: allowSquashMerge,
+        allow_rebase_merge: allowRebaseMerge
       }) : client.rest.repos.createForAuthenticatedUser({
         name: repo,
         private: repoVisibility === "private",
-        description
+        description,
+        delete_branch_on_merge: deleteBranchOnMerge,
+        allow_merge_commit: allowMergeCommit,
+        allow_squash_merge: allowSquashMerge,
+        allow_rebase_merge: allowRebaseMerge
       });
       const { data: newRepo } = await repoCreationPromise;
       if (access == null ? void 0 : access.startsWith(`${owner}/`)) {
@@ -2008,49 +2041,10 @@ function createGithubWebhookAction(options) {
   });
 }
 
-class OctokitProvider {
-  constructor(integrations, githubCredentialsProvider) {
-    this.integrations = integrations;
-    this.githubCredentialsProvider = githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
-  }
-  async getOctokit(repoUrl, options) {
-    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}`);
-    }
-    if (options == null ? void 0 : options.token) {
-      const client2 = new octokit.Octokit({
-        auth: options.token,
-        baseUrl: integrationConfig.apiBaseUrl,
-        previews: ["nebula-preview"]
-      });
-      return { client: client2, token: options.token, owner, repo };
-    }
-    const { token } = await this.githubCredentialsProvider.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 octokit.Octokit({
-      auth: token,
-      baseUrl: integrationConfig.apiBaseUrl,
-      previews: ["nebula-preview"]
-    });
-    return { client, token, owner, repo };
-  }
-}
-
 const createBuiltinActions = (options) => {
   const {
     reader,
     integrations,
-    containerRunner,
     catalogClient,
     config,
     additionalTemplateFilters
@@ -2104,16 +2098,6 @@ const createBuiltinActions = (options) => {
       githubCredentialsProvider
     })
   ];
-  if (containerRunner) {
-    backendCommon.getRootLogger().warn(`[DEPRECATED] The fetch:cookiecutter action will be removed part of the default scaffolder actions in later versions. 
-You can install the package seperately and remove the containerRunner from the createBuiltInActions to remove this warning,
-or you can migrate to using fetch:template https://backstage.io/docs/features/software-templates/builtin-actions#migrating-from-fetchcookiecutter-to-fetchtemplate`);
-    actions.push(pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction({
-      reader,
-      integrations,
-      containerRunner
-    }));
-  }
   return actions;
 };
 
@@ -2872,9 +2856,9 @@ async function findTemplate(options) {
   if (entityRef.kind.toLocaleLowerCase("en-US") !== "template") {
     throw new errors.InputError(`Invalid kind, only 'Template' kind is supported`);
   }
-  const template = await catalogApi.getEntityByName(entityRef, { token });
+  const template = await catalogApi.getEntityByRef(entityRef, { token });
   if (!template) {
-    throw new errors.NotFoundError(`Template ${entityRef} not found`);
+    throw new errors.NotFoundError(`Template ${catalogModel.stringifyEntityRef(entityRef)} not found`);
   }
   return template;
 }
@@ -2892,7 +2876,6 @@ async function createRouter(options) {
     database,
     catalogClient,
     actions,
-    containerRunner,
     taskWorkers,
     additionalTemplateFilters
   } = options;
@@ -2924,7 +2907,6 @@ async function createRouter(options) {
   const actionsToRegister = Array.isArray(actions) ? actions : createBuiltinActions({
     integrations,
     catalogClient,
-    containerRunner,
     reader,
     config,
     additionalTemplateFilters
@@ -3119,7 +3101,7 @@ class ScaffolderEntitiesProcessor {
     return false;
   }
   async postProcessEntity(entity, _location, emit) {
-    const selfRef = catalogModel.getEntityName(entity);
+    const selfRef = catalogModel.getCompoundEntityRef(entity);
     if (entity.apiVersion === "scaffolder.backstage.io/v1beta3" && entity.kind === "Template") {
       const template = entity;
       const target = template.spec.owner;
@@ -3128,7 +3110,7 @@ class ScaffolderEntitiesProcessor {
           defaultKind: "Group",
           defaultNamespace: selfRef.namespace
         });
-        emit(pluginCatalogBackend.results.relation({
+        emit(pluginCatalogBackend.processingResult.relation({
           source: selfRef,
           type: catalogModel.RELATION_OWNED_BY,
           target: {
@@ -3137,7 +3119,7 @@ class ScaffolderEntitiesProcessor {
             name: targetRef.name
           }
         }));
-        emit(pluginCatalogBackend.results.relation({
+        emit(pluginCatalogBackend.processingResult.relation({
           source: {
             kind: targetRef.kind,
             namespace: targetRef.namespace,
@@ -3152,12 +3134,7 @@ class ScaffolderEntitiesProcessor {
   }
 }
 
-Object.defineProperty(exports, 'createFetchCookiecutterAction', {
-  enumerable: true,
-  get: function () { return pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction; }
-});
 exports.DatabaseTaskStore = DatabaseTaskStore;
-exports.OctokitProvider = OctokitProvider;
 exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
 exports.TaskManager = TaskManager;
 exports.TaskWorker = TaskWorker;