diff --git a/.changeset/moody-ducks-return.md b/.changeset/moody-ducks-return.md new file mode 100644 index 0000000000..090b2f5db4 --- /dev/null +++ b/.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. 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.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..3bf90d1e30 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/githubPullRequest.ts +++ b/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) {