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

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/plugin-scaffolder-backend-module-github
 
+## 0.4.0-next.1
+
+### Patch Changes
+
+- 141f366: Added action to enable GitHub Pages on a repo
+- dfaa28d: Adds `requireLastPushApproval` input property to configure Branch Protection Settings in `github:publish` action
+
+  Adds `requireLastPushApproval` input property to configure Branch Protection Settings in `github:repo:push` action
+
+- Updated dependencies
+  - @backstage/backend-common@0.23.3-next.1
+  - @backstage/backend-plugin-api@0.6.22-next.1
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration@1.13.0-next.0
+  - @backstage/plugin-scaffolder-node@0.4.8-next.1
+
 ## 0.4.0-next.0
 
 ### Minor Changes

package/dist/index.cjs.js

@@ -12,6 +12,7 @@ var webhooks = require('@octokit/webhooks');
 var path = require('path');
 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');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
@@ -32,6 +33,7 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   requiredStatusCheckContexts = [],
   requireBranchesToBeUpToDate = true,
   requiredConversationResolution = false,
+  requireLastPushApproval = false,
   defaultBranch = "master",
   enforceAdmins = true,
   dismissStaleReviews = false,
@@ -63,7 +65,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
           required_approving_review_count: requiredApprovingReviewCount,
           require_code_owner_reviews: requireCodeOwnerReviews,
           bypass_pull_request_allowances: bypassPullRequestAllowances,
-          dismiss_stale_reviews: dismissStaleReviews
+          dismiss_stale_reviews: dismissStaleReviews,
+          require_last_push_approval: requireLastPushApproval
         },
         required_conversation_resolution: requiredConversationResolution
       });
@@ -303,7 +306,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, requiredApprovingReviewCount, restrictions, requiredStatusCheckContexts, requireBranchesToBeUpToDate, requiredConversationResolution, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail, dismissStaleReviews, requiredCommitSigning) {
+async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, bypassPullRequestAllowances, requiredApprovingReviewCount, restrictions, requiredStatusCheckContexts, requireBranchesToBeUpToDate, requiredConversationResolution, requireLastPushApproval, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail, dismissStaleReviews, requiredCommitSigning) {
   const gitAuthorInfo = {
     name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
     email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
@@ -336,6 +339,7 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         requiredConversationResolution,
+        requireLastPushApproval,
         enforceAdmins: protectEnforceAdmins,
         dismissStaleReviews,
         requiredCommitSigning
@@ -373,7 +377,7 @@ function getGitCommitMessage(gitCommitMessage, config) {
   return gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage");
 }
 
-const examples$9 = [
+const examples$a = [
   {
     description: "GitHub Action Workflow Without Inputs.",
     example: yaml__default.default.stringify({
@@ -434,7 +438,7 @@ function createGithubActionsDispatchAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
-    examples: examples$9,
+    examples: examples$a,
     schema: {
       input: {
         type: "object",
@@ -503,7 +507,7 @@ function createGithubActionsDispatchAction(options) {
   });
 }
 
-const examples$8 = [
+const examples$9 = [
   {
     description: "Add labels to pull request or issue",
     example: yaml__default.default.stringify({
@@ -544,7 +548,7 @@ function createGithubIssuesLabelAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:label",
     description: "Adds labels to a pull request or issue on GitHub.",
-    examples: examples$8,
+    examples: examples$9,
     schema: {
       input: {
         type: "object",
@@ -654,6 +658,11 @@ const requiredConversationResolution = {
   description: "Requires all conversations on code to be resolved before a pull request can be merged into this branch",
   type: "boolean"
 };
+const requireLastPushApproval = {
+  title: "Require last push approval",
+  type: "boolean",
+  description: `Whether the most recent push to a PR must be approved by someone other than the person who pushed it. The default value is 'false'`
+};
 const repoVisibility = {
   title: "Repository Visibility",
   type: "string",
@@ -888,7 +897,7 @@ const commitHash = {
   type: "string"
 };
 
-const examples$7 = [
+const examples$8 = [
   {
     description: "Creates a GitHub repository with default configuration.",
     example: yaml__default.default.stringify({
@@ -941,7 +950,7 @@ function createGithubRepoCreateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
-    examples: examples$7,
+    examples: examples$8,
     schema: {
       input: {
         type: "object",
@@ -1051,7 +1060,7 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
-const examples$6 = [
+const examples$7 = [
   {
     description: "Setup repo with no modifications to branch protection rules",
     example: yaml__default.default.stringify({
@@ -1103,7 +1112,7 @@ function createGithubRepoPushAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:push",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
-    examples: examples$6,
+    examples: examples$7,
     schema: {
       input: {
         type: "object",
@@ -1118,6 +1127,7 @@ function createGithubRepoPushAction(options) {
           restrictions: restrictions,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           requiredConversationResolution: requiredConversationResolution,
+          requireLastPushApproval: requireLastPushApproval,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
           protectEnforceAdmins: protectEnforceAdmins,
@@ -1155,6 +1165,7 @@ function createGithubRepoPushAction(options) {
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
         requiredConversationResolution = false,
+        requireLastPushApproval = false,
         token: providedToken,
         requiredCommitSigning = false
       } = ctx.input;
@@ -1190,6 +1201,7 @@ function createGithubRepoPushAction(options) {
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         requiredConversationResolution,
+        requireLastPushApproval,
         config,
         ctx.logger,
         gitCommitMessage,
@@ -1205,7 +1217,7 @@ function createGithubRepoPushAction(options) {
   });
 }
 
-const examples$5 = [
+const examples$6 = [
   {
     description: "Create a GitHub webhook for a repository",
     example: yaml__default.default.stringify({
@@ -1314,7 +1326,7 @@ function createGithubWebhookAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:webhook",
     description: "Creates webhook for a repository on GitHub.",
-    examples: examples$5,
+    examples: examples$6,
     supportsDryRun: true,
     schema: {
       input: {
@@ -1432,7 +1444,7 @@ function createGithubWebhookAction(options) {
   });
 }
 
-const examples$4 = [
+const examples$5 = [
   {
     description: "Example 1: Create and store a Deploy Key",
     example: yaml__default.default.stringify({
@@ -1457,7 +1469,7 @@ function createGithubDeployKeyAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:deployKey:create",
     description: "Creates and stores Deploy Keys",
-    examples: examples$4,
+    examples: examples$5,
     schema: {
       input: {
         type: "object",
@@ -1560,7 +1572,7 @@ function createGithubDeployKeyAction(options) {
   });
 }
 
-const examples$3 = [
+const examples$4 = [
   {
     description: "Create a GitHub Environment (No Policies, No Variables, No Secrets)",
     example: yaml__default.default.stringify({
@@ -1645,7 +1657,7 @@ function createGithubEnvironmentAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:environment:create",
     description: "Creates Deployment Environments",
-    examples: examples$3,
+    examples: examples$4,
     schema: {
       input: {
         type: "object",
@@ -1815,7 +1827,7 @@ function createGithubEnvironmentAction(options) {
   });
 }
 
-const examples$2 = [
+const examples$3 = [
   {
     description: "Create a pull request",
     example: yaml__default.default.stringify({
@@ -2099,7 +2111,7 @@ const createPublishGithubPullRequestAction = (options) => {
   } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
-    examples: examples$2,
+    examples: examples$3,
     supportsDryRun: true,
     schema: {
       input: {
@@ -2383,7 +2395,7 @@ const createPublishGithubPullRequestAction = (options) => {
   }
 };
 
-const examples$1 = [
+const examples$2 = [
   {
     description: "Initializes a git repository with the content in the workspace, and publishes it to GitHub with the default configuration.",
     example: yaml__default.default.stringify({
@@ -2438,7 +2450,7 @@ function createPublishGithubAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
-    examples: examples$1,
+    examples: examples$2,
     schema: {
       input: {
         type: "object",
@@ -2456,6 +2468,7 @@ function createPublishGithubAction(options) {
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           requiredConversationResolution: requiredConversationResolution,
+          requireLastPushApproval: requireLastPushApproval,
           repoVisibility: repoVisibility,
           defaultBranch: defaultBranch,
           protectDefaultBranch: protectDefaultBranch,
@@ -2506,6 +2519,7 @@ function createPublishGithubAction(options) {
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
         requiredConversationResolution = false,
+        requireLastPushApproval = false,
         repoVisibility = "private",
         defaultBranch = "master",
         protectDefaultBranch = true,
@@ -2587,6 +2601,7 @@ function createPublishGithubAction(options) {
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
         requiredConversationResolution,
+        requireLastPushApproval,
         config,
         ctx.logger,
         gitCommitMessage,
@@ -2602,7 +2617,7 @@ function createPublishGithubAction(options) {
   });
 }
 
-const examples = [
+const examples$1 = [
   {
     description: "GitHub alphanumric autolink reference",
     example: yaml__default.default.stringify({
@@ -2627,7 +2642,7 @@ function createGithubAutolinksAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:autolinks:create",
     description: "Create an autolink reference for a repository",
-    examples,
+    examples: examples$1,
     schema: {
       input: {
         type: "object",
@@ -2688,6 +2703,106 @@ function createGithubAutolinksAction(options) {
   });
 }
 
+const examples = [
+  {
+    description: "Enables GitHub Pages for a repository.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:pages",
+          id: "github-pages",
+          name: "Enable GitHub Pages",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            buildType: "workflow",
+            sourceBranch: "main",
+            sourcePath: "/",
+            token: "gph_YourGitHubToken"
+          }
+        }
+      ]
+    })
+  }
+];
+
+function createGithubPagesEnableAction(options) {
+  const { integrations, githubCredentialsProvider } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "github:pages:enable",
+    examples,
+    description: "Enables GitHub Pages for a repository.",
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl"],
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the new repository name and 'owner' is an organization or username`,
+            type: "string"
+          },
+          buildType: {
+            title: "Build Type",
+            type: "string",
+            description: 'The GitHub Pages build type - "legacy" or "workflow". Default is "workflow'
+          },
+          sourceBranch: {
+            title: "Source Branch",
+            type: "string",
+            description: 'The the GitHub Pages source branch. Default is "main"'
+          },
+          sourcePath: {
+            title: "Source Path",
+            type: "string",
+            description: 'The the GitHub Pages source path - "/" or "/docs". Default is "/"'
+          },
+          token: {
+            title: "Authorization Token",
+            type: "string",
+            description: "The token to use for authorization to GitHub"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        repoUrl,
+        buildType = "workflow",
+        sourceBranch = "main",
+        sourcePath = "/",
+        token: providedToken
+      } = ctx.input;
+      const octokitOptions = await pluginScaffolderBackendModuleGithub.getOctokitOptions({
+        integrations,
+        credentialsProvider: githubCredentialsProvider,
+        token: providedToken,
+        repoUrl
+      });
+      const client = new octokit.Octokit(octokitOptions);
+      const { owner, repo } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
+      if (!owner) {
+        throw new errors.InputError("Invalid repository owner provided in repoUrl");
+      }
+      ctx.logger.info(
+        `Attempting to enable GitHub Pages for ${owner}/${repo} with "${buildType}" build type, on source branch "${sourceBranch}" and source path "${sourcePath}"`
+      );
+      await client.request("POST /repos/{owner}/{repo}/pages", {
+        owner,
+        repo,
+        build_type: buildType,
+        source: {
+          branch: sourceBranch,
+          path: sourcePath
+        },
+        headers: {
+          "X-GitHub-Api-Version": "2022-11-28"
+        }
+      });
+      ctx.logger.info("Completed enabling GitHub Pages");
+    }
+  });
+}
+
 const githubModule = backendPluginApi.createBackendModule({
   pluginId: "scaffolder",
   moduleId: "github",
@@ -2737,6 +2852,10 @@ const githubModule = backendPluginApi.createBackendModule({
             integrations,
             githubCredentialsProvider,
             config
+          }),
+          createGithubPagesEnableAction({
+            integrations,
+            githubCredentialsProvider
           })
         );
       }
@@ -2749,6 +2868,7 @@ exports.createGithubAutolinksAction = createGithubAutolinksAction;
 exports.createGithubDeployKeyAction = createGithubDeployKeyAction;
 exports.createGithubEnvironmentAction = createGithubEnvironmentAction;
 exports.createGithubIssuesLabelAction = createGithubIssuesLabelAction;
+exports.createGithubPagesEnableAction = createGithubPagesEnableAction;
 exports.createGithubRepoCreateAction = createGithubRepoCreateAction;
 exports.createGithubRepoPushAction = createGithubRepoPushAction;
 exports.createGithubWebhookAction = createGithubWebhookAction;