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

package/CHANGELOG.md

@@ -1,5 +1,84 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.9.0
+
+### Minor Changes
+
+- a20a0ea698: Added `requiredConversationResolution` template option to `github:repo:create`, `github:repo:push` and `publish:github`
+- b32005e98a: Deprecated the `taskWorkers` option in RouterOptions in favor of `concurrentTasksLimit` which sets the limit of concurrent tasks in a single TaskWorker
+
+  TaskWorker can now run multiple (defaults to 10) tasks concurrently using the `concurrentTasksLimit` option available in both `RouterOptions` and `CreateWorkerOptions`.
+
+  To use the option to create a TaskWorker:
+
+  ```diff
+  const worker = await TaskWorker.create({
+      taskBroker,
+      actionRegistry,
+      integrations,
+      logger,
+      workingDirectory,
+      additionalTemplateFilters,
+  +   concurrentTasksLimit: 10 // (1 to Infinity)
+  });
+  ```
+
+- fc51bd8aa0: Add support for disabling Github repository wiki, issues and projects
+- 0053d07bee: Update the `github:publish` action to allow passing wether to dismiss stale reviews on the protected default branch.
+
+### Patch Changes
+
+- cb716004ef: Internal refactor to improve tests
+- 935b66a646: Change step output template examples to use square bracket syntax.
+- 884d749b14: Refactored to use `coreServices` from `@backstage/backend-plugin-api`.
+- b05dcd5530: Move the `zod` dependency to a version that does not collide with other libraries
+- 26404430bc: Use Json types from @backstage/types
+- b07ccffad0: Backend now returns 'ui:options' value from template metadata, it can be used by all your custom scaffolder components.
+- 309f2daca4: Updated dependency `esbuild` to `^0.16.0`.
+- 3280711113: Updated dependency `msw` to `^0.49.0`.
+- 19356df560: Updated dependency `zen-observable` to `^0.9.0`.
+- c3fa90e184: Updated dependency `zen-observable` to `^0.10.0`.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.6.0
+  - @backstage/catalog-client@1.2.0
+  - @backstage/backend-common@0.17.0
+  - @backstage/plugin-catalog-node@1.3.0
+  - @backstage/backend-tasks@0.4.0
+  - @backstage/errors@1.1.4
+  - @backstage/backend-plugin-api@0.2.0
+  - @backstage/integration@1.4.1
+  - @backstage/plugin-auth-node@0.2.8
+  - @backstage/types@1.0.2
+  - @backstage/catalog-model@1.1.4
+  - @backstage/config@1.0.5
+  - @backstage/plugin-scaffolder-common@1.2.3
+
+## 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",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -299,6 +299,7 @@ apps?: string[] | undefined;
 } | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
+requiredConversationResolution?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -311,6 +312,9 @@ access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 username: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 })[] | undefined;
+hasProjects?: boolean | undefined;
+hasWiki?: boolean | undefined;
+hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
 }>;
@@ -335,6 +339,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 bypassPullRequestAllowances?: {
 users?: string[];
 teams?: string[];
@@ -342,6 +347,7 @@ apps?: string[];
 } | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
+requiredConversationResolution?: boolean | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 }>;
@@ -508,8 +514,10 @@ teams?: string[];
 apps?: string[];
 } | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
+requiredConversationResolution?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -522,6 +530,9 @@ access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 username: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 })[] | undefined;
+hasProjects?: boolean | undefined;
+hasWiki?: boolean | undefined;
+hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
 }>;

package/dist/index.beta.d.ts

@@ -299,6 +299,7 @@ apps?: string[] | undefined;
 } | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
+requiredConversationResolution?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -311,6 +312,9 @@ access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 username: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 })[] | undefined;
+hasProjects?: boolean | undefined;
+hasWiki?: boolean | undefined;
+hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
 }>;
@@ -335,6 +339,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 bypassPullRequestAllowances?: {
 users?: string[];
 teams?: string[];
@@ -342,6 +347,7 @@ apps?: string[];
 } | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
+requiredConversationResolution?: boolean | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 }>;
@@ -508,8 +514,10 @@ teams?: string[];
 apps?: string[];
 } | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
+requiredConversationResolution?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
 collaborators?: ({
 user: string;
@@ -522,6 +530,9 @@ access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 username: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 })[] | undefined;
+hasProjects?: boolean | undefined;
+hasWiki?: boolean | undefined;
+hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
 }>;

package/dist/index.cjs.js

@@ -998,8 +998,10 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   bypassPullRequestAllowances,
   requiredStatusCheckContexts = [],
   requireBranchesToBeUpToDate = true,
+  requiredConversationResolution = false,
   defaultBranch = "master",
-  enforceAdmins = true
+  enforceAdmins = true,
+  dismissStaleReviews = false
 }) => {
   const tryOnce = async () => {
     try {
@@ -1019,8 +1021,10 @@ 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
+        },
+        required_conversation_resolution: requiredConversationResolution
       });
     } catch (e) {
       errors.assertError(e);
@@ -1086,7 +1090,7 @@ async function getOctokitOptions(options) {
     previews: ["nebula-preview"]
   };
 }
-async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, homepage, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, allowRebaseMerge, allowAutoMerge, access, collaborators, topics, logger) {
+async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, homepage, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, allowRebaseMerge, allowAutoMerge, access, collaborators, hasProjects, hasWiki, hasIssues, topics, logger) {
   const user = await client.rest.users.getByUsername({
     username: owner
   });
@@ -1101,7 +1105,10 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
     allow_squash_merge: allowSquashMerge,
     allow_rebase_merge: allowRebaseMerge,
     allow_auto_merge: allowAutoMerge,
-    homepage
+    homepage,
+    has_projects: hasProjects,
+    has_wiki: hasWiki,
+    has_issues: hasIssues
   }) : client.rest.repos.createForAuthenticatedUser({
     name: repo,
     private: repoVisibility === "private",
@@ -1111,7 +1118,10 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
     allow_squash_merge: allowSquashMerge,
     allow_rebase_merge: allowRebaseMerge,
     allow_auto_merge: allowAutoMerge,
-    homepage
+    homepage,
+    has_projects: hasProjects,
+    has_wiki: hasWiki,
+    has_issues: hasIssues
   });
   let newRepo;
   try {
@@ -1186,7 +1196,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, requiredConversationResolution, 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 +1226,9 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
-        enforceAdmins: protectEnforceAdmins
+        requiredConversationResolution,
+        enforceAdmins: protectEnforceAdmins,
+        dismissStaleReviews
       });
     } catch (e) {
       errors.assertError(e);
@@ -1398,6 +1410,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",
@@ -1411,6 +1428,11 @@ const requireBranchesToBeUpToDate = {
   description: `Require branches to be up to date before merging. The default value is 'true'`,
   type: "boolean"
 };
+const requiredConversationResolution = {
+  title: "Required Conversation Resolution",
+  description: "Requires all conversations on code to be resolved before a pull request can be merged into this branch",
+  type: "boolean"
+};
 const repoVisibility = {
   title: "Repository Visibility",
   type: "string",
@@ -1477,6 +1499,21 @@ const collaborators = {
     oneOf: [{ required: ["user"] }, { required: ["team"] }]
   }
 };
+const hasProjects = {
+  title: "Enable projects",
+  type: "boolean",
+  description: `Enable projects for the repository. The default value is 'true' unless the organization has disabled repository projects`
+};
+const hasWiki = {
+  title: "Enable the wiki",
+  type: "boolean",
+  description: `Enable the wiki for the repository. The default value is 'true'`
+};
+const hasIssues = {
+  title: "Enable issues",
+  type: "boolean",
+  description: `Enable issues for the repository. The default value is 'true'`
+};
 const token = {
   title: "Authentication Token",
   type: "string",
@@ -1568,6 +1605,7 @@ function createGithubRepoCreateAction(options) {
           bypassPullRequestAllowances: bypassPullRequestAllowances,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
+          requiredConversationResolution: requiredConversationResolution,
           repoVisibility: repoVisibility,
           deleteBranchOnMerge: deleteBranchOnMerge,
           allowMergeCommit: allowMergeCommit,
@@ -1575,6 +1613,9 @@ function createGithubRepoCreateAction(options) {
           allowRebaseMerge: allowRebaseMerge,
           allowAutoMerge: allowAutoMerge,
           collaborators: collaborators,
+          hasProjects: hasProjects,
+          hasWiki: hasWiki,
+          hasIssues: hasIssues,
           token: token,
           topics: topics
         }
@@ -1600,6 +1641,9 @@ function createGithubRepoCreateAction(options) {
         allowRebaseMerge = true,
         allowAutoMerge = false,
         collaborators,
+        hasProjects = void 0,
+        hasWiki = void 0,
+        hasIssues = void 0,
         topics,
         token: providedToken
       } = ctx.input;
@@ -1628,6 +1672,9 @@ function createGithubRepoCreateAction(options) {
         allowAutoMerge,
         access,
         collaborators,
+        hasProjects,
+        hasWiki,
+        hasIssues,
         topics,
         ctx.logger
       );
@@ -1648,9 +1695,11 @@ function createGithubRepoPushAction(options) {
         properties: {
           repoUrl: repoUrl,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
+          dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
+          requiredConversationResolution: requiredConversationResolution,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
           protectEnforceAdmins: protectEnforceAdmins,
@@ -1679,9 +1728,11 @@ function createGithubRepoPushAction(options) {
         gitAuthorName,
         gitAuthorEmail,
         requireCodeOwnerReviews = false,
+        dismissStaleReviews = false,
         bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
+        requiredConversationResolution = false,
         token: providedToken
       } = ctx.input;
       const { owner, repo } = parseRepoUrl(repoUrl, integrations);
@@ -1713,11 +1764,13 @@ function createGithubRepoPushAction(options) {
         bypassPullRequestAllowances,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
+        requiredConversationResolution,
         config,
         ctx.logger,
         gitCommitMessage,
         gitAuthorName,
-        gitAuthorEmail
+        gitAuthorEmail,
+        dismissStaleReviews
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -2931,8 +2984,10 @@ function createPublishGithubAction(options) {
           access: access,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
+          dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
+          requiredConversationResolution: requiredConversationResolution,
           repoVisibility: repoVisibility,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
@@ -2947,6 +3002,9 @@ function createPublishGithubAction(options) {
           allowAutoMerge: allowAutoMerge,
           sourcePath: sourcePath,
           collaborators: collaborators,
+          hasProjects: hasProjects,
+          hasWiki: hasWiki,
+          hasIssues: hasIssues,
           token: token,
           topics: topics
         }
@@ -2966,9 +3024,11 @@ function createPublishGithubAction(options) {
         homepage,
         access,
         requireCodeOwnerReviews = false,
+        dismissStaleReviews = false,
         bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
+        requiredConversationResolution = false,
         repoVisibility = "private",
         defaultBranch = "master",
         protectDefaultBranch = true,
@@ -2982,6 +3042,9 @@ function createPublishGithubAction(options) {
         allowRebaseMerge = true,
         allowAutoMerge = false,
         collaborators,
+        hasProjects = void 0,
+        hasWiki = void 0,
+        hasIssues = void 0,
         topics,
         token: providedToken
       } = ctx.input;
@@ -3010,6 +3073,9 @@ function createPublishGithubAction(options) {
         allowAutoMerge,
         access,
         collaborators,
+        hasProjects,
+        hasWiki,
+        hasIssues,
         topics,
         ctx.logger
       );
@@ -3030,11 +3096,13 @@ function createPublishGithubAction(options) {
         bypassPullRequestAllowances,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
+        requiredConversationResolution,
         config,
         ctx.logger,
         gitCommitMessage,
         gitAuthorName,
-        gitAuthorEmail
+        gitAuthorEmail,
+        dismissStaleReviews
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -4937,6 +5005,7 @@ async function createRouter(options) {
         res.json({
           title: (_b = template.metadata.title) != null ? _b : template.metadata.name,
           description: template.metadata.description,
+          "ui:options": template.metadata["ui:options"],
           steps: parameters.map((schema) => {
             var _a2;
             return {