From aabd601b114386a16b91d230e2c36ae36e50edb7 Mon Sep 17 00:00:00 2001 From: Simon Gellis Date: Wed, 23 Mar 2022 17:45:53 -0400 Subject: [PATCH 1/5] Support creating draft github PRs Signed-off-by: Simon Gellis --- .../actions/builtin/publish/githubPullRequest.test.ts | 2 ++ .../actions/builtin/publish/githubPullRequest.ts | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.test.ts index 464498c0c4..d030430924 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.test.ts +++ b/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', diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts index 30293f2654..ca4827e423 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts @@ -114,6 +114,7 @@ export const createPublishGithubPullRequestAction = ({ title: string; branchName: string; description: string; + draft?: boolean; repoUrl: string; targetPath?: string; sourcePath?: 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) { From 5fd5a1ae806614aa3a38c7e32c96f0f1ed4c5bba Mon Sep 17 00:00:00 2001 From: Simon Gellis Date: Wed, 23 Mar 2022 17:53:13 -0400 Subject: [PATCH 2/5] Update API docs Signed-off-by: Simon Gellis --- plugins/scaffolder-backend/api-report.md | 1 + .../src/scaffolder/actions/builtin/publish/githubPullRequest.ts | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index 89ca6b55bd..2c44004e5b 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/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; diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts index ca4827e423..3bf90d1e30 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts @@ -114,8 +114,8 @@ export const createPublishGithubPullRequestAction = ({ title: string; branchName: string; description: string; - draft?: boolean; repoUrl: string; + draft?: boolean; targetPath?: string; sourcePath?: string; token?: string; From f5f921dafb9ee07b89fd563d833834b7d02c1880 Mon Sep 17 00:00:00 2001 From: Simon Gellis Date: Wed, 23 Mar 2022 17:59:13 -0400 Subject: [PATCH 3/5] Add changeset Signed-off-by: Simon Gellis --- .changeset/moody-ducks-return.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/moody-ducks-return.md diff --git a/.changeset/moody-ducks-return.md b/.changeset/moody-ducks-return.md new file mode 100644 index 0000000000..93d03be66d --- /dev/null +++ b/.changeset/moody-ducks-return.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder-backend': patch +--- + +Add new option to create draft GitHub PRs From 434c2d2313c2e41d1feb1bf187b468774dc7c9c0 Mon Sep 17 00:00:00 2001 From: Simon Gellis Date: Fri, 25 Mar 2022 14:15:46 -0400 Subject: [PATCH 4/5] Add to next minor version Signed-off-by: Simon Gellis --- .changeset/moody-ducks-return.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/moody-ducks-return.md b/.changeset/moody-ducks-return.md index 93d03be66d..314f8fc705 100644 --- a/.changeset/moody-ducks-return.md +++ b/.changeset/moody-ducks-return.md @@ -1,5 +1,5 @@ --- -'@backstage/plugin-scaffolder-backend': patch +'@backstage/plugin-scaffolder-backend': minor --- Add new option to create draft GitHub PRs From bf6d36a062cb911d26ed25c3483ffd08fd5ab69f Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 28 Mar 2022 11:45:42 +0200 Subject: [PATCH 5/5] update changeset Signed-off-by: Johan Haals --- .changeset/moody-ducks-return.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/moody-ducks-return.md b/.changeset/moody-ducks-return.md index 314f8fc705..090b2f5db4 100644 --- a/.changeset/moody-ducks-return.md +++ b/.changeset/moody-ducks-return.md @@ -2,4 +2,4 @@ '@backstage/plugin-scaffolder-backend': minor --- -Add new option to create draft GitHub PRs +Add new `draft` option to the `publish:github:pull-request` action.