From 2e01ccacfb2797720c1866a2541a6a528bd58cbb Mon Sep 17 00:00:00 2001
From: Romain Billon <romain.billon@agicap.com>
Date: Sat, 1 Jun 2024 21:36:43 +0200
Subject: [PATCH] feat: add forceEmptyGitAuthor option to GitHub pull request
 action

This update introduces the `forceEmptyGitAuthor` option to the GitHub pull request action in the scaffolder-backend-module-github. This new boolean option allows for the author information to be omitted from commits, which is particularly useful when using a GitHub App, enabling commits to be verified on GitHub.

Signed-off-by: Romain Billon <romain.billon@agicap.com>
---
 .../src/actions/githubPullRequest.ts          | 45 ++++++++++++-------
 1 file changed, 28 insertions(+), 17 deletions(-)

diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts b/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts
index 213d24eca7..fb6a932f11 100644
--- a/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts
+++ b/plugins/scaffolder-backend-module-github/src/actions/githubPullRequest.ts
@@ -146,6 +146,7 @@ export const createPublishGithubPullRequestAction = (
     forceFork?: boolean;
     gitAuthorName?: string;
     gitAuthorEmail?: string;
+    forceEmptyGitAuthor?: boolean;
   }>({
     id: 'publish:github:pull-request',
     examples,
@@ -246,6 +247,12 @@ export const createPublishGithubPullRequestAction = (
             description:
               "Sets the default author email for the commit. The default value is the authenticated user or 'scaffolder@backstage.io'",
           },
+          forceEmptyGitAuthor: {
+            type: 'boolean',
+            title: 'Force Empty Git Author',
+            description:
+              'Forces the author to be empty. This is useful when using a Github App, it permit the commit to be verified on Github',
+          },
         },
       },
       output: {
@@ -287,6 +294,7 @@ export const createPublishGithubPullRequestAction = (
         forceFork,
         gitAuthorEmail,
         gitAuthorName,
+        forceEmptyGitAuthor,
       } = ctx.input;
 
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
@@ -384,26 +392,29 @@ export const createPublishGithubPullRequestAction = (
             config?.getOptionalString('scaffolder.defaultAuthor.email'),
         };
 
-        if (gitAuthorInfo.name || gitAuthorInfo.email) {
-          if (Array.isArray(createOptions.changes)) {
-            createOptions.changes = createOptions.changes.map(change => ({
-              ...change,
-              author: {
-                name: gitAuthorInfo.name || 'Scaffolder',
-                email: gitAuthorInfo.email || 'scaffolder@backstage.io',
-              },
-            }));
-          } else {
-            createOptions.changes = {
-              ...createOptions.changes,
-              author: {
-                name: gitAuthorInfo.name || 'Scaffolder',
-                email: gitAuthorInfo.email || 'scaffolder@backstage.io',
-              },
-            };
+        if (!forceEmptyGitAuthor) {
+          if (gitAuthorInfo.name || gitAuthorInfo.email) {
+            if (Array.isArray(createOptions.changes)) {
+              createOptions.changes = createOptions.changes.map(change => ({
+                ...change,
+                author: {
+                  name: gitAuthorInfo.name || 'Scaffolder',
+                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',
+                },
+              }));
+            } else {
+              createOptions.changes = {
+                ...createOptions.changes,
+                author: {
+                  name: gitAuthorInfo.name || 'Scaffolder',
+                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',
+                },
+              };
+            }
           }
         }
 
+
         if (targetBranchName) {
           createOptions.base = targetBranchName;
         }