@backstage/plugin-scaffolder-backend-module-github 0.5.1-next.0 → 0.5.1-next.2

package/dist/index.d.ts

@@ -387,6 +387,38 @@ declare function createGithubPagesEnableAction(options: {
     token?: string | undefined;
 }, _backstage_types.JsonObject>;
 
+/**
+ * Creates an `github:branch-protection:create` Scaffolder action that configured Branch Protection in a Github Repository.
+ *
+ * @public
+ */
+declare function createGithubBranchProtectionAction(options: {
+    integrations: ScmIntegrationRegistry;
+}): _backstage_plugin_scaffolder_node.TemplateAction<{
+    repoUrl: string;
+    branch?: string | undefined;
+    enforceAdmins?: boolean | undefined;
+    requiredApprovingReviewCount?: number | undefined;
+    requireCodeOwnerReviews?: boolean | undefined;
+    dismissStaleReviews?: boolean | undefined;
+    bypassPullRequestAllowances?: {
+        users?: string[];
+        teams?: string[];
+        apps?: string[];
+    } | undefined;
+    restrictions?: {
+        users: string[];
+        teams: string[];
+        apps?: string[];
+    } | undefined;
+    requiredStatusCheckContexts?: string[] | undefined;
+    requireBranchesToBeUpToDate?: boolean | undefined;
+    requiredConversationResolution?: boolean | undefined;
+    requireLastPushApproval?: boolean | undefined;
+    requiredCommitSigning?: boolean | undefined;
+    token?: string | undefined;
+}, _backstage_types.JsonObject>;
+
 /**
  * Helper for generating octokit configuration options for given repoUrl.
  * If no token is provided, it will attempt to get a token from the credentials provider.
@@ -405,4 +437,4 @@ declare function getOctokitOptions(options: {
  */
 declare const githubModule: _backstage_backend_plugin_api.BackendFeature;
 
-export { type CreateGithubPullRequestActionOptions, createGithubActionsDispatchAction, createGithubAutolinksAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesLabelAction, createGithubPagesEnableAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishGithubAction, createPublishGithubPullRequestAction, githubModule as default, getOctokitOptions };
+export { type CreateGithubPullRequestActionOptions, createGithubActionsDispatchAction, createGithubAutolinksAction, createGithubBranchProtectionAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesLabelAction, createGithubPagesEnableAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishGithubAction, createPublishGithubPullRequestAction, githubModule as default, getOctokitOptions };

package/dist/module.cjs.js

@@ -0,0 +1,92 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-scaffolder-node/alpha');
+var githubActionsDispatch = require('./actions/githubActionsDispatch.cjs.js');
+var githubIssuesLabel = require('./actions/githubIssuesLabel.cjs.js');
+var githubRepoCreate = require('./actions/githubRepoCreate.cjs.js');
+var githubRepoPush = require('./actions/githubRepoPush.cjs.js');
+var githubWebhook = require('./actions/githubWebhook.cjs.js');
+var githubDeployKey = require('./actions/githubDeployKey.cjs.js');
+var githubEnvironment = require('./actions/githubEnvironment.cjs.js');
+var githubPullRequest = require('./actions/githubPullRequest.cjs.js');
+var github = require('./actions/github.cjs.js');
+var githubAutolinks = require('./actions/githubAutolinks.cjs.js');
+var githubPagesEnable = require('./actions/githubPagesEnable.cjs.js');
+var githubBranchProtection = require('./actions/githubBranchProtection.cjs.js');
+require('@backstage/errors');
+var integration = require('@backstage/integration');
+require('@backstage/plugin-scaffolder-node');
+require('libsodium-wrappers');
+var catalogClient = require('@backstage/catalog-client');
+
+const githubModule = backendPluginApi.createBackendModule({
+  pluginId: "scaffolder",
+  moduleId: "github",
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        scaffolder: alpha.scaffolderActionsExtensionPoint,
+        config: backendPluginApi.coreServices.rootConfig,
+        discovery: backendPluginApi.coreServices.discovery
+      },
+      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(
+          githubActionsDispatch.createGithubActionsDispatchAction({
+            integrations,
+            githubCredentialsProvider
+          }),
+          githubAutolinks.createGithubAutolinksAction({
+            integrations,
+            githubCredentialsProvider
+          }),
+          githubDeployKey.createGithubDeployKeyAction({
+            integrations
+          }),
+          githubEnvironment.createGithubEnvironmentAction({
+            integrations,
+            catalogClient: catalogClient$1
+          }),
+          githubIssuesLabel.createGithubIssuesLabelAction({
+            integrations,
+            githubCredentialsProvider
+          }),
+          githubRepoCreate.createGithubRepoCreateAction({
+            integrations,
+            githubCredentialsProvider
+          }),
+          githubRepoPush.createGithubRepoPushAction({ integrations, config }),
+          githubWebhook.createGithubWebhookAction({
+            integrations,
+            githubCredentialsProvider
+          }),
+          github.createPublishGithubAction({
+            integrations,
+            config,
+            githubCredentialsProvider
+          }),
+          githubPullRequest.createPublishGithubPullRequestAction({
+            integrations,
+            githubCredentialsProvider,
+            config
+          }),
+          githubPagesEnable.createGithubPagesEnableAction({
+            integrations,
+            githubCredentialsProvider
+          }),
+          githubBranchProtection.createGithubBranchProtectionAction({
+            integrations
+          })
+        );
+      }
+    });
+  }
+});
+
+exports.githubModule = githubModule;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport {\n  createGithubActionsDispatchAction,\n  createGithubAutolinksAction,\n  createGithubDeployKeyAction,\n  createGithubEnvironmentAction,\n  createGithubIssuesLabelAction,\n  createGithubRepoCreateAction,\n  createGithubRepoPushAction,\n  createGithubWebhookAction,\n  createPublishGithubAction,\n  createPublishGithubPullRequestAction,\n  createGithubPagesEnableAction,\n  createGithubBranchProtectionAction,\n} from './actions';\nimport {\n  DefaultGithubCredentialsProvider,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport { CatalogClient } from '@backstage/catalog-client';\n\n/**\n * @public\n * The GitHub Module for the Scaffolder Backend\n */\nexport const githubModule = createBackendModule({\n  pluginId: 'scaffolder',\n  moduleId: 'github',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolder: scaffolderActionsExtensionPoint,\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n      },\n      async init({ scaffolder, config, discovery }) {\n        const integrations = ScmIntegrations.fromConfig(config);\n        const githubCredentialsProvider =\n          DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n        const catalogClient = new CatalogClient({\n          discoveryApi: discovery,\n        });\n\n        scaffolder.addActions(\n          createGithubActionsDispatchAction({\n            integrations,\n            githubCredentialsProvider,\n          }),\n          createGithubAutolinksAction({\n            integrations,\n            githubCredentialsProvider,\n          }),\n          createGithubDeployKeyAction({\n            integrations,\n          }),\n          createGithubEnvironmentAction({\n            integrations,\n            catalogClient,\n          }),\n          createGithubIssuesLabelAction({\n            integrations,\n            githubCredentialsProvider,\n          }),\n          createGithubRepoCreateAction({\n            integrations,\n            githubCredentialsProvider,\n          }),\n          createGithubRepoPushAction({ integrations, config }),\n          createGithubWebhookAction({\n            integrations,\n            githubCredentialsProvider,\n          }),\n          createPublishGithubAction({\n            integrations,\n            config,\n            githubCredentialsProvider,\n          }),\n          createPublishGithubPullRequestAction({\n            integrations,\n            githubCredentialsProvider,\n            config,\n          }),\n          createGithubPagesEnableAction({\n            integrations,\n            githubCredentialsProvider,\n          }),\n          createGithubBranchProtectionAction({\n            integrations,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","ScmIntegrations","DefaultGithubCredentialsProvider","catalogClient","CatalogClient","createGithubActionsDispatchAction","createGithubAutolinksAction","createGithubDeployKeyAction","createGithubEnvironmentAction","createGithubIssuesLabelAction","createGithubRepoCreateAction","createGithubRepoPushAction","createGithubWebhookAction","createPublishGithubAction","createPublishGithubPullRequestAction","createGithubPagesEnableAction","createGithubBranchProtectionAction"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA4CO,MAAM,eAAeA,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,YAAA;AAAA,EACV,QAAU,EAAA,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAgB,EAAA;AACzB,IAAa,YAAA,CAAA;AAAA,MACX,IAAM,EAAA;AAAA,QACJ,UAAY,EAAAC,qCAAA;AAAA,QACZ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,UAAY,EAAA,MAAA,EAAQ,WAAa,EAAA;AAC5C,QAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,QAAM,MAAA,yBAAA,GACJC,4CAAiC,CAAA,gBAAA,CAAiB,YAAY,CAAA,CAAA;AAChE,QAAM,MAAAC,eAAA,GAAgB,IAAIC,2BAAc,CAAA;AAAA,UACtC,YAAc,EAAA,SAAA;AAAA,SACf,CAAA,CAAA;AAED,QAAW,UAAA,CAAA,UAAA;AAAA,UACTC,uDAAkC,CAAA;AAAA,YAChC,YAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,2CAA4B,CAAA;AAAA,YAC1B,YAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,2CAA4B,CAAA;AAAA,YAC1B,YAAA;AAAA,WACD,CAAA;AAAA,UACDC,+CAA8B,CAAA;AAAA,YAC5B,YAAA;AAAA,2BACAL,eAAA;AAAA,WACD,CAAA;AAAA,UACDM,+CAA8B,CAAA;AAAA,YAC5B,YAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,6CAA6B,CAAA;AAAA,YAC3B,YAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,yCAA2B,CAAA,EAAE,YAAc,EAAA,MAAA,EAAQ,CAAA;AAAA,UACnDC,uCAA0B,CAAA;AAAA,YACxB,YAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,gCAA0B,CAAA;AAAA,YACxB,YAAA;AAAA,YACA,MAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,sDAAqC,CAAA;AAAA,YACnC,YAAA;AAAA,YACA,yBAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,UACDC,+CAA8B,CAAA;AAAA,YAC5B,YAAA;AAAA,YACA,yBAAA;AAAA,WACD,CAAA;AAAA,UACDC,yDAAmC,CAAA;AAAA,YACjC,YAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-github",
-  "version": "0.5.1-next.0",
+  "version": "0.5.1-next.2",
   "description": "The github module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "backend-plugin-module",
@@ -41,13 +41,13 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "^1.0.1-next.0",
-    "@backstage/catalog-client": "^1.7.0",
-    "@backstage/catalog-model": "^1.7.0",
-    "@backstage/config": "^1.2.0",
-    "@backstage/errors": "^1.2.4",
-    "@backstage/integration": "^1.15.0",
-    "@backstage/plugin-scaffolder-node": "^0.5.0-next.0",
+    "@backstage/backend-plugin-api": "1.0.1-next.1",
+    "@backstage/catalog-client": "1.7.1-next.0",
+    "@backstage/catalog-model": "1.7.0",
+    "@backstage/config": "1.2.0",
+    "@backstage/errors": "1.2.4",
+    "@backstage/integration": "1.15.1-next.1",
+    "@backstage/plugin-scaffolder-node": "0.5.0-next.2",
     "@octokit/webhooks": "^10.9.2",
     "libsodium-wrappers": "^0.7.11",
     "octokit": "^3.0.0",
@@ -55,9 +55,9 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.0.1-next.0",
-    "@backstage/cli": "^0.28.0-next.0",
-    "@backstage/plugin-scaffolder-node-test-utils": "^0.1.13-next.0",
+    "@backstage/backend-test-utils": "1.0.1-next.2",
+    "@backstage/cli": "0.28.0-next.2",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.1.13-next.2",
     "@types/libsodium-wrappers": "^0.7.10",
     "fs-extra": "^11.2.0",
     "jsonschema": "^1.2.6"