Merge pull request #10407 from simongellis-attentive/draft-github-prs

Support creating draft GitHub prs

.changeset/moody-ducks-return.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend': minor
+---
+
+Add new `draft` option to the `publish:github:pull-request` action.

plugins/scaffolder-backend/api-report.md

@@ -251,6 +251,7 @@ export const createPublishGithubPullRequestAction: ({
   branchName: string;
   description: string;
   repoUrl: string;
+  draft?: boolean | undefined;
   targetPath?: string | undefined;
   sourcePath?: string | undefined;
   token?: string | undefined;

plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.test.ts

@@ -85,6 +85,7 @@ describe('createPublishGithubPullRequestAction', () => {
         title: 'Create my new app',
         branchName: 'new-app',
         description: 'This PR is really good',
+        draft: true,
       };
 
       mockFs({
@@ -109,6 +110,7 @@ describe('createPublishGithubPullRequestAction', () => {
         title: 'Create my new app',
         head: 'new-app',
         body: 'This PR is really good',
+        draft: true,
         changes: [
           {
             commit: 'Create my new app',

plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts

@@ -115,6 +115,7 @@ export const createPublishGithubPullRequestAction = ({
     branchName: string;
     description: string;
     repoUrl: string;
+    draft?: boolean;
     targetPath?: string;
     sourcePath?: string;
     token?: string;
@@ -145,6 +146,11 @@ export const createPublishGithubPullRequestAction = ({
             title: 'Pull Request Description',
             description: 'The description of the pull request',
           },
+          draft: {
+            type: 'boolean',
+            title: 'Create as Draft',
+            description: 'Create a draft pull request',
+          },
           sourcePath: {
             type: 'string',
             title: 'Working Subdirectory',
@@ -186,6 +192,7 @@ export const createPublishGithubPullRequestAction = ({
         branchName,
         title,
         description,
+        draft,
         targetPath,
         sourcePath,
         token: providedToken,
@@ -264,6 +271,7 @@ export const createPublishGithubPullRequestAction = ({
           changes,
           body: description,
           head: branchName,
+          draft,
         });
 
         if (!response) {