@backstage/plugin-scaffolder-backend 1.9.0-next.2 → 1.9.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.9.0-next.3
+
+### Minor Changes
+
+- 0053d07bee: Update the `github:publish` action to allow passing wether to dismiss stale reviews on the protected default branch.
+
+### Patch Changes
+
+- 935b66a646: Change step output template examples to use square bracket syntax.
+- b05dcd5530: Move the `zod` dependency to a version that does not collide with other libraries
+- 309f2daca4: Updated dependency `esbuild` to `^0.16.0`.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.6.0-next.3
+  - @backstage/backend-tasks@0.4.0-next.3
+  - @backstage/backend-common@0.17.0-next.3
+  - @backstage/backend-plugin-api@0.2.0-next.3
+  - @backstage/catalog-client@1.2.0-next.1
+  - @backstage/catalog-model@1.1.4-next.1
+  - @backstage/config@1.0.5-next.1
+  - @backstage/errors@1.1.4-next.1
+  - @backstage/integration@1.4.1-next.1
+  - @backstage/types@1.0.2-next.1
+  - @backstage/plugin-auth-node@0.2.8-next.3
+  - @backstage/plugin-catalog-node@1.3.0-next.3
+  - @backstage/plugin-scaffolder-common@1.2.3-next.1
+
 ## 1.9.0-next.2
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -335,6 +335,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 bypassPullRequestAllowances?: {
 users?: string[];
 teams?: string[];
@@ -508,6 +509,7 @@ teams?: string[];
 apps?: string[];
 } | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;

package/dist/index.beta.d.ts

@@ -335,6 +335,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 bypassPullRequestAllowances?: {
 users?: string[];
 teams?: string[];
@@ -508,6 +509,7 @@ teams?: string[];
 apps?: string[];
 } | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;

package/dist/index.cjs.js

@@ -999,7 +999,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   requiredStatusCheckContexts = [],
   requireBranchesToBeUpToDate = true,
   defaultBranch = "master",
-  enforceAdmins = true
+  enforceAdmins = true,
+  dismissStaleReviews = false
 }) => {
   const tryOnce = async () => {
     try {
@@ -1019,7 +1020,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
         required_pull_request_reviews: {
           required_approving_review_count: 1,
           require_code_owner_reviews: requireCodeOwnerReviews,
-          bypass_pull_request_allowances: bypassPullRequestAllowances
+          bypass_pull_request_allowances: bypassPullRequestAllowances,
+          dismiss_stale_reviews: dismissStaleReviews
         }
       });
     } catch (e) {
@@ -1186,7 +1188,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
   }
   return newRepo;
 }
-async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, bypassPullRequestAllowances, 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, dismissStaleReviews) {
   const gitAuthorInfo = {
     name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
     email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
@@ -1216,7 +1218,8 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
-        enforceAdmins: protectEnforceAdmins
+        enforceAdmins: protectEnforceAdmins,
+        dismissStaleReviews
       });
     } catch (e) {
       errors.assertError(e);
@@ -1398,6 +1401,11 @@ const requireCodeOwnerReviews = {
   description: "Require an approved review in PR including files with a designated Code Owner",
   type: "boolean"
 };
+const dismissStaleReviews = {
+  title: "Dismiss Stale Reviews",
+  description: "New reviewable commits pushed to a matching branch will dismiss pull request review approvals.",
+  type: "boolean"
+};
 const requiredStatusCheckContexts = {
   title: "Required Status Check Contexts",
   description: "The list of status checks to require in order to merge into this branch",
@@ -1648,6 +1656,7 @@ function createGithubRepoPushAction(options) {
         properties: {
           repoUrl: repoUrl,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
+          dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
@@ -1679,6 +1688,7 @@ function createGithubRepoPushAction(options) {
         gitAuthorName,
         gitAuthorEmail,
         requireCodeOwnerReviews = false,
+        dismissStaleReviews = false,
         bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
@@ -1717,7 +1727,8 @@ function createGithubRepoPushAction(options) {
         ctx.logger,
         gitCommitMessage,
         gitAuthorName,
-        gitAuthorEmail
+        gitAuthorEmail,
+        dismissStaleReviews
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -2931,6 +2942,7 @@ function createPublishGithubAction(options) {
           access: access,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
+          dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           repoVisibility: repoVisibility,
@@ -2966,6 +2978,7 @@ function createPublishGithubAction(options) {
         homepage,
         access,
         requireCodeOwnerReviews = false,
+        dismissStaleReviews = false,
         bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
@@ -3034,7 +3047,8 @@ function createPublishGithubAction(options) {
         ctx.logger,
         gitCommitMessage,
         gitAuthorName,
-        gitAuthorEmail
+        gitAuthorEmail,
+        dismissStaleReviews
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);