@backstage/plugin-scaffolder-backend-module-github 0.5.0-next.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @backstage/plugin-scaffolder-backend-module-github
 
+## 0.5.0
+
+### Minor Changes
+
+- d425fc4: **BREAKING**: The return values from `createBackendPlugin`, `createBackendModule`, and `createServiceFactory` are now simply `BackendFeature` and `ServiceFactory`, instead of the previously deprecated form of a function that returns them. For this reason, `createServiceFactory` also no longer accepts the callback form where you provide direct options to the service. This also affects all `coreServices.*` service refs.
+
+  This may in particular affect tests; if you were effectively doing `createBackendModule({...})()` (note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in your `packages/backend/src/index.ts` too, where you add plugins, modules, and services. If you were using `createServiceFactory` with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.
+
+  As part of this change, the `IdentityFactoryOptions` type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to [migrate to the new auth system](https://backstage.io/docs/tutorials/auth-service-migration) if you still rely on it.
+
+### Patch Changes
+
+- 22a19e6: Added the ability for the actions `publish:github` and `github:repo:create` to take inputs for 'custom properties' for organization repositories.
+- 162cdf4: Update dependency @octokit/webhooks to 10.9.2 due to SNYK-JS-OCTOKITWEBHOOKS-6129527
+- 7976081: Added support for all request parameters in the Github create/update environment API in the Github environment create scaffolder action.
+
+  Disable MultiEntityPicker when `maxItems` limit is reached defined in `JSONSchema`
+
+- Updated dependencies
+  - @backstage/backend-common@0.25.0
+  - @backstage/backend-plugin-api@1.0.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/catalog-client@1.7.0
+  - @backstage/integration@1.15.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-scaffolder-node@0.4.11
+
+## 0.5.0-next.2
+
+### Patch Changes
+
+- 22a19e6: Added the ability for the actions `publish:github` and `github:repo:create` to take inputs for 'custom properties' for organization repositories.
+- Updated dependencies
+  - @backstage/backend-common@0.25.0-next.2
+  - @backstage/backend-plugin-api@1.0.0-next.2
+  - @backstage/integration@1.15.0-next.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-scaffolder-node@0.4.11-next.2
+
 ## 0.5.0-next.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -14,6 +14,7 @@ var octokitPluginCreatePullRequest = require('octokit-plugin-create-pull-request
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var pluginScaffolderBackendModuleGithub = require('@backstage/plugin-scaffolder-backend-module-github');
 var alpha = require('@backstage/plugin-scaffolder-node/alpha');
+var catalogClient = require('@backstage/catalog-client');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -144,7 +145,7 @@ async function getOctokitOptions(options) {
     previews: ["nebula-preview"]
   };
 }
-async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, homepage, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, squashMergeCommitTitle, squashMergeCommitMessage, allowRebaseMerge, allowAutoMerge, access, collaborators, hasProjects, hasWiki, hasIssues, topics, repoVariables, secrets, oidcCustomization, logger) {
+async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, homepage, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, squashMergeCommitTitle, squashMergeCommitMessage, allowRebaseMerge, allowAutoMerge, access, collaborators, hasProjects, hasWiki, hasIssues, topics, repoVariables, secrets, oidcCustomization, customProperties, logger) {
   const user = await client.rest.users.getByUsername({
     username: owner
   });
@@ -168,7 +169,9 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
     homepage,
     has_projects: hasProjects,
     has_wiki: hasWiki,
-    has_issues: hasIssues
+    has_issues: hasIssues,
+    // Custom properties only available on org repos
+    custom_properties: customProperties
   }) : client.rest.repos.createForAuthenticatedUser({
     name: repo,
     private: repoVisibility === "private",
@@ -883,6 +886,11 @@ const oidcCustomization = {
     }
   }
 };
+const customProperties = {
+  title: "Custom Repository Properties",
+  description: "Custom properties to be added to the repository (note, this only works for organization repositories)",
+  type: "object"
+};
 
 const remoteUrl = {
   title: "A URL to the repository with the provider",
@@ -1890,7 +1898,8 @@ function createGithubRepoCreateAction(options) {
           repoVariables: repoVariables,
           secrets: secrets,
           oidcCustomization: oidcCustomization,
-          requiredCommitSigning: requiredCommitSigning
+          requiredCommitSigning: requiredCommitSigning,
+          customProperties: customProperties
         }
       },
       output: {
@@ -1923,6 +1932,7 @@ function createGithubRepoCreateAction(options) {
         repoVariables,
         secrets,
         oidcCustomization,
+        customProperties,
         token: providedToken
       } = ctx.input;
       const octokitOptions = await getOctokitOptions({
@@ -1959,6 +1969,7 @@ function createGithubRepoCreateAction(options) {
         repoVariables,
         secrets,
         oidcCustomization,
+        customProperties,
         ctx.logger
       );
       ctx.output("remoteUrl", newRepo.clone_url);
@@ -2757,11 +2768,59 @@ const examples$4 = [
         }
       ]
     })
+  },
+  {
+    description: "Create a GitHub Environment with Wait Timer",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            waitTimer: 1e3
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Prevent Self Review",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            preventSelfReview: true
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Reviewers",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            reviewers: ["group:default/team-a", "user:default/johndoe"]
+          }
+        }
+      ]
+    })
   }
 ];
 
 function createGithubEnvironmentAction(options) {
-  const { integrations } = options;
+  const { integrations, catalogClient } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:environment:create",
     description: "Creates Deployment Environments",
@@ -2833,6 +2892,24 @@ function createGithubEnvironmentAction(options) {
             title: "Authentication Token",
             type: "string",
             description: "The token to use for authorization to GitHub"
+          },
+          waitTimer: {
+            title: "Wait Timer",
+            type: "integer",
+            description: "The time to wait before creating or updating the environment (in milliseconds)"
+          },
+          preventSelfReview: {
+            title: "Prevent Self Review",
+            type: "boolean",
+            description: "Whether to prevent self-review for this environment"
+          },
+          reviewers: {
+            title: "Reviewers",
+            type: "array",
+            description: "Reviewers for this environment",
+            items: {
+              type: "string"
+            }
           }
         }
       }
@@ -2846,8 +2923,12 @@ function createGithubEnvironmentAction(options) {
         customTagPolicyNames,
         environmentVariables,
         secrets,
-        token: providedToken
+        token: providedToken,
+        waitTimer,
+        preventSelfReview,
+        reviewers
       } = ctx.input;
+      await new Promise((resolve) => setTimeout(resolve, 2e3));
       const octokitOptions = await getOctokitOptions({
         integrations,
         token: providedToken,
@@ -2862,11 +2943,52 @@ function createGithubEnvironmentAction(options) {
         owner,
         repo
       });
+      const githubReviewers = [];
+      if (reviewers) {
+        let reviewersEntityRefs = [];
+        const catalogResponse = await catalogClient?.getEntitiesByRefs({
+          entityRefs: reviewers
+        });
+        if (catalogResponse?.items?.length) {
+          reviewersEntityRefs = catalogResponse.items;
+        }
+        for (const reviewerEntityRef of reviewersEntityRefs) {
+          if (reviewerEntityRef?.kind === "User") {
+            try {
+              const user = await client.rest.users.getByUsername({
+                username: reviewerEntityRef.metadata.name
+              });
+              githubReviewers.push({
+                type: "User",
+                id: user.data.id
+              });
+            } catch (error) {
+              ctx.logger.error("User not found:", error);
+            }
+          } else if (reviewerEntityRef?.kind === "Group") {
+            try {
+              const team = await client.rest.teams.getByName({
+                org: owner,
+                team_slug: reviewerEntityRef.metadata.name
+              });
+              githubReviewers.push({
+                type: "Team",
+                id: team.data.id
+              });
+            } catch (error) {
+              ctx.logger.error("Team not found:", error);
+            }
+          }
+        }
+      }
       await client.rest.repos.createOrUpdateEnvironment({
         owner,
         repo,
         environment_name: name,
-        deployment_branch_policy: deploymentBranchPolicy ?? null
+        deployment_branch_policy: deploymentBranchPolicy ?? null,
+        wait_timer: waitTimer ?? 0,
+        prevent_self_review: preventSelfReview ?? false,
+        reviewers: githubReviewers.length ? githubReviewers : null
       });
       if (customBranchPolicyNames) {
         for (const item of customBranchPolicyNames) {
@@ -3603,7 +3725,8 @@ function createPublishGithubAction(options) {
           repoVariables: repoVariables,
           secrets: secrets,
           oidcCustomization: oidcCustomization,
-          requiredCommitSigning: requiredCommitSigning
+          requiredCommitSigning: requiredCommitSigning,
+          customProperties: customProperties
         }
       },
       output: {
@@ -3653,6 +3776,7 @@ function createPublishGithubAction(options) {
         secrets,
         oidcCustomization,
         token: providedToken,
+        customProperties,
         requiredCommitSigning = false
       } = ctx.input;
       const octokitOptions = await getOctokitOptions({
@@ -3689,6 +3813,7 @@ function createPublishGithubAction(options) {
         repoVariables,
         secrets,
         oidcCustomization,
+        customProperties,
         ctx.logger
       );
       const remoteUrl = newRepo.clone_url;
@@ -4112,11 +4237,15 @@ const githubModule = backendPluginApi.createBackendModule({
     registerInit({
       deps: {
         scaffolder: alpha.scaffolderActionsExtensionPoint,
-        config: backendPluginApi.coreServices.rootConfig
+        config: backendPluginApi.coreServices.rootConfig,
+        discovery: backendPluginApi.coreServices.discovery
       },
-      async init({ scaffolder, config }) {
+      async init({ scaffolder, config, discovery }) {
         const integrations = integration.ScmIntegrations.fromConfig(config);
         const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
+        const catalogClient$1 = new catalogClient.CatalogClient({
+          discoveryApi: discovery
+        });
         scaffolder.addActions(
           createGithubActionsDispatchAction({
             integrations,
@@ -4130,7 +4259,8 @@ const githubModule = backendPluginApi.createBackendModule({
             integrations
           }),
           createGithubEnvironmentAction({
-            integrations
+            integrations,
+            catalogClient: catalogClient$1
           }),
           createGithubIssuesLabelAction({
             integrations,