@backstage/plugin-scaffolder-backend 1.8.0-next.0 → 1.8.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.8.0-next.2
+
+### Minor Changes
+
+- 5025d2e8b6: Adds the ability to pass (an optional) array of strings that will be applied to the newly scaffolded repository as topic labels.
+
+### Patch Changes
+
+- 969a8444ea: Updated dependency `esbuild` to `^0.15.0`.
+- 9ff4ff3745: Implement "Branch protection rules" support for "publish:github" action
+- Updated dependencies
+  - @backstage/backend-common@0.16.0-next.1
+  - @backstage/backend-plugin-api@0.1.4-next.1
+  - @backstage/backend-tasks@0.3.7-next.1
+  - @backstage/plugin-auth-node@0.2.7-next.1
+  - @backstage/plugin-catalog-backend@1.5.1-next.1
+  - @backstage/plugin-catalog-node@1.2.1-next.1
+  - @backstage/catalog-client@1.1.2-next.0
+  - @backstage/catalog-model@1.1.3-next.0
+  - @backstage/config@1.0.4-next.0
+  - @backstage/errors@1.1.3-next.0
+  - @backstage/integration@1.4.0-next.0
+  - @backstage/types@1.0.1-next.0
+  - @backstage/plugin-scaffolder-common@1.2.2-next.0
+
+## 1.8.0-next.1
+
+### Minor Changes
+
+- 5921b5ce49: - The GitLab Project ID for the `publish:gitlab:merge-request` action is now passed through the query parameter `project` in the `repoUrl`. It still allows people to not use the `projectid` and use the `repoUrl` with the `owner` and `repo` query parameters instead. This makes it easier to publish to repositories instead of writing the full path to the project.
+
 ## 1.8.0-next.0
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -292,6 +292,11 @@ allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
 allowAutoMerge?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+bypassPullRequestAllowances?: {
+users?: string[] | undefined;
+teams?: string[] | undefined;
+apps?: string[] | undefined;
+} | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -330,6 +335,11 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+bypassPullRequestAllowances?: {
+users?: string[];
+teams?: string[];
+apps?: string[];
+} | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 sourcePath?: string | undefined;
@@ -492,6 +502,11 @@ allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
 allowAutoMerge?: boolean | undefined;
 sourcePath?: string | undefined;
+bypassPullRequestAllowances?: {
+users?: string[];
+teams?: string[];
+apps?: string[];
+} | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
@@ -547,6 +562,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 setUserAsOwner?: boolean | undefined;
+topics?: string[] | undefined;
 }>;
 
 /**
@@ -565,7 +581,7 @@ sourcePath?: string | undefined;
 targetPath?: string | undefined;
 token?: string | undefined;
 commitAction?: "update" | "create" | "delete" | undefined;
-/** @deprecated Use projectPath instead */
+/** @deprecated projectID passed as query parameters in the repoUrl */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;
 assignee?: string | undefined;

package/dist/index.beta.d.ts

@@ -292,6 +292,11 @@ allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
 allowAutoMerge?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+bypassPullRequestAllowances?: {
+users?: string[] | undefined;
+teams?: string[] | undefined;
+apps?: string[] | undefined;
+} | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -330,6 +335,11 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+bypassPullRequestAllowances?: {
+users?: string[];
+teams?: string[];
+apps?: string[];
+} | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 sourcePath?: string | undefined;
@@ -492,6 +502,11 @@ allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
 allowAutoMerge?: boolean | undefined;
 sourcePath?: string | undefined;
+bypassPullRequestAllowances?: {
+users?: string[];
+teams?: string[];
+apps?: string[];
+} | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
@@ -547,6 +562,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 setUserAsOwner?: boolean | undefined;
+topics?: string[] | undefined;
 }>;
 
 /**
@@ -565,7 +581,7 @@ sourcePath?: string | undefined;
 targetPath?: string | undefined;
 token?: string | undefined;
 commitAction?: "update" | "create" | "delete" | undefined;
-/** @deprecated Use projectPath instead */
+/** @deprecated projectID passed as query parameters in the repoUrl */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;
 assignee?: string | undefined;

package/dist/index.cjs.js

@@ -851,34 +851,41 @@ const parseRepoUrl = (repoUrl, integrations) => {
       `No matching integration configuration for host ${host}, please check your integrations config`
     );
   }
-  if (type === "bitbucket") {
-    if (host === "bitbucket.org") {
-      if (!workspace) {
-        throw new errors.InputError(
-          `Invalid repo URL passed to publisher: ${repoUrl}, missing workspace`
-        );
+  const repo = parsed.searchParams.get("repo");
+  switch (type) {
+    case "bitbucket": {
+      if (host === "www.bitbucket.org") {
+        checkRequiredParams(parsed, "workspace");
       }
+      checkRequiredParams(parsed, "project", "repo");
+      break;
     }
-    if (!project) {
-      throw new errors.InputError(
-        `Invalid repo URL passed to publisher: ${repoUrl}, missing project`
-      );
+    case "gitlab": {
+      if (!project) {
+        checkRequiredParams(parsed, "owner", "repo");
+      }
+      break;
     }
-  } else {
-    if (!owner && type !== "gerrit") {
-      throw new errors.InputError(
-        `Invalid repo URL passed to publisher: ${repoUrl}, missing owner`
-      );
+    case "gerrit": {
+      checkRequiredParams(parsed, "repo");
+      break;
+    }
+    default: {
+      checkRequiredParams(parsed, "repo", "owner");
+      break;
     }
-  }
-  const repo = parsed.searchParams.get("repo");
-  if (!repo) {
-    throw new errors.InputError(
-      `Invalid repo URL passed to publisher: ${repoUrl}, missing repo`
-    );
   }
   return { host, owner, repo, organization, workspace, project };
 };
+function checkRequiredParams(repoUrl, ...params) {
+  for (let i = 0; i < params.length; i++) {
+    if (!repoUrl.searchParams.get(params[i])) {
+      throw new errors.InputError(
+        `Invalid repo URL passed to publisher: ${repoUrl.toString()}, missing ${params[i]}`
+      );
+    }
+  }
+}
 
 const executeShellCommand = async (options) => {
   const {
@@ -986,6 +993,7 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   owner,
   logger,
   requireCodeOwnerReviews,
+  bypassPullRequestAllowances,
   requiredStatusCheckContexts = [],
   requireBranchesToBeUpToDate = true,
   defaultBranch = "master",
@@ -1008,7 +1016,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
         enforce_admins: enforceAdmins,
         required_pull_request_reviews: {
           required_approving_review_count: 1,
-          require_code_owner_reviews: requireCodeOwnerReviews
+          require_code_owner_reviews: requireCodeOwnerReviews,
+          bypass_pull_request_allowances: bypassPullRequestAllowances
         }
       });
     } catch (e) {
@@ -1175,7 +1184,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, requireBranchesToBeUpToDate, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail) {
+async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, bypassPullRequestAllowances, 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 +1210,7 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         repoName: repo,
         logger,
         defaultBranch,
+        bypassPullRequestAllowances,
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
@@ -1492,6 +1502,32 @@ const protectEnforceAdmins = {
   type: "boolean",
   description: `Enforce admins to adhere to default branch protection. The default value is 'true'`
 };
+const bypassPullRequestAllowances = {
+  title: "Bypass pull request requirements",
+  description: "Allow specific users, teams, or apps to bypass pull request requirements.",
+  type: "object",
+  additionalProperties: false,
+  properties: {
+    apps: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    },
+    users: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    },
+    teams: {
+      type: "array",
+      items: {
+        type: "string"
+      }
+    }
+  }
+};
 const gitCommitMessage = {
   title: "Git Commit Message",
   type: "string",
@@ -1527,6 +1563,7 @@ function createGithubRepoCreateAction(options) {
           homepage: homepage,
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
+          bypassPullRequestAllowances: bypassPullRequestAllowances,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           repoVisibility: repoVisibility,
@@ -1610,6 +1647,7 @@ function createGithubRepoPushAction(options) {
           repoUrl: repoUrl,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
+          bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
@@ -1639,6 +1677,7 @@ function createGithubRepoPushAction(options) {
         gitAuthorName,
         gitAuthorEmail,
         requireCodeOwnerReviews = false,
+        bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
         token: providedToken
@@ -1669,6 +1708,7 @@ function createGithubRepoPushAction(options) {
         client,
         repo,
         requireCodeOwnerReviews,
+        bypassPullRequestAllowances,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         config,
@@ -2887,6 +2927,7 @@ function createPublishGithubAction(options) {
           description: description,
           homepage: homepage,
           access: access,
+          bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
@@ -2923,6 +2964,7 @@ function createPublishGithubAction(options) {
         homepage,
         access,
         requireCodeOwnerReviews = false,
+        bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
         repoVisibility = "private",
@@ -2983,6 +3025,7 @@ function createPublishGithubAction(options) {
         client,
         repo,
         requireCodeOwnerReviews,
+        bypassPullRequestAllowances,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         config,
@@ -3333,6 +3376,14 @@ function createPublishGitlabAction(options) {
             title: "Set User As Owner",
             type: "boolean",
             description: "Set the token user as owner of the newly created repository. Requires a token authorized to do the edit in the integration configuration for the matching host"
+          },
+          topics: {
+            title: "Topic labels",
+            description: "Topic labels to apply on the repository.",
+            type: "array",
+            items: {
+              type: "string"
+            }
           }
         }
       },
@@ -3362,7 +3413,8 @@ function createPublishGitlabAction(options) {
         gitCommitMessage = "initial commit",
         gitAuthorName,
         gitAuthorEmail,
-        setUserAsOwner = false
+        setUserAsOwner = false,
+        topics = []
       } = ctx.input;
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -3393,7 +3445,8 @@ function createPublishGitlabAction(options) {
       const { id: projectId, http_url_to_repo } = await client.Projects.create({
         namespace_id: targetNamespace,
         name: repo,
-        visibility: repoVisibility
+        visibility: repoVisibility,
+        ...topics.length ? { topics } : {}
       });
       if (setUserAsOwner && integrationConfig.config.token) {
         const adminClient = new node.Gitlab({
@@ -3525,13 +3578,11 @@ const createPublishGitlabMergeRequestAction = (options) => {
         title,
         token: providedToken
       } = ctx.input;
-      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);
-      const projectPath = `${owner}/${repo}`;
-      if (ctx.input.projectid) {
-        const deprecationWarning = `Property "projectid" is deprecated and no longer to needed to create a MR`;
-        ctx.logger.warn(deprecationWarning);
-        console.warn(deprecationWarning);
-      }
+      const { host, owner, repo, project } = parseRepoUrl(
+        repoUrl,
+        integrations
+      );
+      const repoID = project ? project : `${owner}/${repo}`;
       const integrationConfig = integrations.gitlab.byHost(host);
       if (!integrationConfig) {
         throw new errors.InputError(
@@ -3579,19 +3630,15 @@ const createPublishGitlabMergeRequestAction = (options) => {
           execute_filemode: file.executable
         };
       });
-      const projects = await api.Projects.show(projectPath);
+      const projects = await api.Projects.show(repoID);
       const { default_branch: defaultBranch } = projects;
       try {
-        await api.Branches.create(
-          projectPath,
-          branchName,
-          String(defaultBranch)
-        );
+        await api.Branches.create(repoID, branchName, String(defaultBranch));
       } catch (e) {
         throw new errors.InputError(`The branch creation failed ${e}`);
       }
       try {
-        await api.Commits.create(projectPath, branchName, title, actions);
+        await api.Commits.create(repoID, branchName, ctx.input.title, actions);
       } catch (e) {
         throw new errors.InputError(
           `Committing the changes to ${branchName} failed ${e}`
@@ -3599,7 +3646,7 @@ const createPublishGitlabMergeRequestAction = (options) => {
       }
       try {
         const mergeRequestUrl = await api.MergeRequests.create(
-          projectPath,
+          repoID,
           branchName,
           String(defaultBranch),
           title,
@@ -3611,8 +3658,8 @@ const createPublishGitlabMergeRequestAction = (options) => {
         ).then((mergeRequest) => {
           return mergeRequest.web_url;
         });
-        ctx.output("projectid", projectPath);
-        ctx.output("projectPath", projectPath);
+        ctx.output("projectid", repoID);
+        ctx.output("projectPath", repoID);
         ctx.output("mergeRequestUrl", mergeRequestUrl);
       } catch (e) {
         throw new errors.InputError(`Merge request creation failed${e}`);