@backstage/plugin-scaffolder-backend 1.7.0-next.1 → 1.7.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.7.0-next.2
+
+### Minor Changes
+
+- 17ff77154c: Update the `github:publish` action to allow passing whether pull
+  requests must be up to date with the default branch before merging.
+- a8e9848479: Added optional `sourcePath` parameter to `publish:gitlab:merge-request` action, `targetPath` is now optional and falls back to current workspace path.
+
+### Patch Changes
+
+- 4880d43e25: Fixed setting default branch for Bitbucket Server
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.2.0-next.2
+  - @backstage/plugin-catalog-backend@1.5.0-next.2
+  - @backstage/backend-tasks@0.3.6-next.2
+  - @backstage/backend-common@0.15.2-next.2
+  - @backstage/backend-plugin-api@0.1.3-next.2
+  - @backstage/plugin-auth-node@0.2.6-next.2
+  - @backstage/catalog-client@1.1.1-next.2
+  - @backstage/catalog-model@1.1.2-next.2
+  - @backstage/config@1.0.3-next.2
+  - @backstage/errors@1.1.2-next.2
+  - @backstage/integration@1.3.2-next.2
+  - @backstage/types@1.0.0
+  - @backstage/plugin-scaffolder-common@1.2.1-next.2
+
 ## 1.7.0-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.7.0-next.1",
+  "version": "1.7.0-next.2",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -293,6 +293,7 @@ allowMergeCommit?: boolean | undefined;
 allowAutoMerge?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
+requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -330,6 +331,7 @@ gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
+requireBranchesToBeUpToDate?: boolean | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 }>;
@@ -492,6 +494,7 @@ allowAutoMerge?: boolean | undefined;
 sourcePath?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
+requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -558,7 +561,8 @@ repoUrl: string;
 title: string;
 description: string;
 branchName: string;
-targetPath: string;
+sourcePath?: string | undefined;
+targetPath?: string | undefined;
 token?: string | undefined;
 commitAction?: "update" | "create" | "delete" | undefined;
 /** @deprecated Use projectPath instead */

package/dist/index.beta.d.ts

@@ -293,6 +293,7 @@ allowMergeCommit?: boolean | undefined;
 allowAutoMerge?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
+requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -330,6 +331,7 @@ gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
+requireBranchesToBeUpToDate?: boolean | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 }>;
@@ -492,6 +494,7 @@ allowAutoMerge?: boolean | undefined;
 sourcePath?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
+requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -558,7 +561,8 @@ repoUrl: string;
 title: string;
 description: string;
 branchName: string;
-targetPath: string;
+sourcePath?: string | undefined;
+targetPath?: string | undefined;
 token?: string | undefined;
 commitAction?: "update" | "create" | "delete" | undefined;
 /** @deprecated Use projectPath instead */

package/dist/index.cjs.js

@@ -986,6 +986,7 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   logger,
   requireCodeOwnerReviews,
   requiredStatusCheckContexts = [],
+  requireBranchesToBeUpToDate = true,
   defaultBranch = "master",
   enforceAdmins = true
 }) => {
@@ -999,7 +1000,7 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
         repo: repoName,
         branch: defaultBranch,
         required_status_checks: {
-          strict: true,
+          strict: requireBranchesToBeUpToDate,
           contexts: requiredStatusCheckContexts
         },
         restrictions: null,
@@ -1173,7 +1174,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
   }
   return newRepo;
 }
-async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail) {
+async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, requiredStatusCheckContexts, requireBranchesToBeUpToDate, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail) {
   const gitAuthorInfo = {
     name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
     email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
@@ -1201,6 +1202,7 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         defaultBranch,
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
+        requireBranchesToBeUpToDate,
         enforceAdmins: protectEnforceAdmins
       });
     } catch (e) {
@@ -1391,6 +1393,11 @@ const requiredStatusCheckContexts = {
     type: "string"
   }
 };
+const requireBranchesToBeUpToDate = {
+  title: "Require Branches To Be Up To Date?",
+  description: `Require branches to be up to date before merging. The default value is 'true'`,
+  type: "boolean"
+};
 const repoVisibility = {
   title: "Repository Visibility",
   type: "string",
@@ -1520,6 +1527,7 @@ function createGithubRepoCreateAction(options) {
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
+          requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           repoVisibility: repoVisibility,
           deleteBranchOnMerge: deleteBranchOnMerge,
           allowMergeCommit: allowMergeCommit,
@@ -1601,6 +1609,7 @@ function createGithubRepoPushAction(options) {
           repoUrl: repoUrl,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
+          requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
           protectEnforceAdmins: protectEnforceAdmins,
@@ -1630,6 +1639,7 @@ function createGithubRepoPushAction(options) {
         gitAuthorEmail,
         requireCodeOwnerReviews = false,
         requiredStatusCheckContexts = [],
+        requireBranchesToBeUpToDate = true,
         token: providedToken
       } = ctx.input;
       const { owner, repo } = parseRepoUrl(repoUrl, integrations);
@@ -1659,6 +1669,7 @@ function createGithubRepoPushAction(options) {
         repo,
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
+        requireBranchesToBeUpToDate,
         config,
         ctx.logger,
         gitCommitMessage,
@@ -2419,6 +2430,7 @@ const createRepository = async (opts) => {
     description,
     authorization,
     repoVisibility,
+    defaultBranch,
     apiBaseUrl
   } = opts;
   let response;
@@ -2427,6 +2439,7 @@ const createRepository = async (opts) => {
     body: JSON.stringify({
       name: repo,
       description,
+      defaultBranch,
       public: repoVisibility === "public"
     }),
     headers: {
@@ -2569,6 +2582,7 @@ function createPublishBitbucketServerAction(options) {
         project,
         repo,
         repoVisibility,
+        defaultBranch,
         description,
         apiBaseUrl
       });
@@ -2874,6 +2888,7 @@ function createPublishGithubAction(options) {
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
+          requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           repoVisibility: repoVisibility,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
@@ -2908,6 +2923,7 @@ function createPublishGithubAction(options) {
         access,
         requireCodeOwnerReviews = false,
         requiredStatusCheckContexts = [],
+        requireBranchesToBeUpToDate = true,
         repoVisibility = "private",
         defaultBranch = "master",
         protectDefaultBranch = true,
@@ -2967,6 +2983,7 @@ function createPublishGithubAction(options) {
         repo,
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
+        requireBranchesToBeUpToDate,
         config,
         ctx.logger,
         gitCommitMessage,
@@ -3415,7 +3432,7 @@ const createPublishGitlabMergeRequestAction = (options) => {
     id: "publish:gitlab:merge-request",
     schema: {
       input: {
-        required: ["repoUrl", "targetPath", "branchName"],
+        required: ["repoUrl", "branchName"],
         type: "object",
         properties: {
           repoUrl: {
@@ -3443,6 +3460,11 @@ const createPublishGitlabMergeRequestAction = (options) => {
             title: "Destination Branch name",
             description: "The description of the merge request"
           },
+          sourcePath: {
+            type: "string",
+            title: "Working Subdirectory",
+            description: "Subdirectory of working directory to copy changes from"
+          },
           targetPath: {
             type: "string",
             title: "Repository Subdirectory",
@@ -3491,8 +3513,17 @@ const createPublishGitlabMergeRequestAction = (options) => {
       }
     },
     async handler(ctx) {
-      var _a;
-      const repoUrl = ctx.input.repoUrl;
+      const {
+        assignee,
+        branchName,
+        description,
+        repoUrl,
+        removeSourceBranch,
+        targetPath,
+        sourcePath,
+        title,
+        token: providedToken
+      } = ctx.input;
       const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);
       const projectPath = `${owner}/${repo}`;
       if (ctx.input.projectid) {
@@ -3501,22 +3532,20 @@ const createPublishGitlabMergeRequestAction = (options) => {
         console.warn(deprecationWarning);
       }
       const integrationConfig = integrations.gitlab.byHost(host);
-      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 && !ctx.input.token) {
+      if (!integrationConfig.config.token && !providedToken) {
         throw new errors.InputError(`No token available for host ${host}`);
       }
-      const token = (_a = ctx.input.token) != null ? _a : integrationConfig.config.token;
-      const tokenType = ctx.input.token ? "oauthToken" : "token";
+      const token = providedToken != null ? providedToken : integrationConfig.config.token;
+      const tokenType = providedToken ? "oauthToken" : "token";
       const api = new node.Gitlab({
         host: integrationConfig.config.baseUrl,
         [tokenType]: token
       });
-      const assignee = ctx.input.assignee;
       let assigneeId = void 0;
       if (assignee !== void 0) {
         try {
@@ -3528,18 +3557,22 @@ const createPublishGitlabMergeRequestAction = (options) => {
           );
         }
       }
-      const targetPath = backendCommon.resolveSafeChildPath(
-        ctx.workspacePath,
-        ctx.input.targetPath
-      );
-      const fileContents = await serializeDirectoryContents(targetPath, {
+      let fileRoot;
+      if (sourcePath) {
+        fileRoot = backendCommon.resolveSafeChildPath(ctx.workspacePath, sourcePath);
+      } else if (targetPath) {
+        fileRoot = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
+      } else {
+        fileRoot = ctx.workspacePath;
+      }
+      const fileContents = await serializeDirectoryContents(fileRoot, {
         gitignore: true
       });
       const actions = fileContents.map((file) => {
-        var _a2;
+        var _a;
         return {
-          action: (_a2 = ctx.input.commitAction) != null ? _a2 : "create",
-          filePath: path__default["default"].posix.join(ctx.input.targetPath, file.path),
+          action: (_a = ctx.input.commitAction) != null ? _a : "create",
+          filePath: targetPath ? path__default["default"].posix.join(targetPath, file.path) : file.path,
           encoding: "base64",
           content: file.content.toString("base64"),
           execute_filemode: file.executable
@@ -3550,33 +3583,28 @@ const createPublishGitlabMergeRequestAction = (options) => {
       try {
         await api.Branches.create(
           projectPath,
-          destinationBranch,
+          branchName,
           String(defaultBranch)
         );
       } catch (e) {
         throw new errors.InputError(`The branch creation failed ${e}`);
       }
       try {
-        await api.Commits.create(
-          projectPath,
-          destinationBranch,
-          ctx.input.title,
-          actions
-        );
+        await api.Commits.create(projectPath, branchName, title, actions);
       } catch (e) {
         throw new errors.InputError(
-          `Committing the changes to ${destinationBranch} failed ${e}`
+          `Committing the changes to ${branchName} failed ${e}`
         );
       }
       try {
         const mergeRequestUrl = await api.MergeRequests.create(
           projectPath,
-          destinationBranch,
+          branchName,
           String(defaultBranch),
-          ctx.input.title,
+          title,
           {
-            description: ctx.input.description,
-            removeSourceBranch: ctx.input.removeSourceBranch ? ctx.input.removeSourceBranch : false,
+            description,
+            removeSourceBranch: removeSourceBranch ? removeSourceBranch : false,
             assigneeId
           }
         ).then((mergeRequest) => {