Backstage
Docs
Github
Preparing search index...
@backstage/plugin-scaffolder-backend-module-github
createPublishGithubPullRequestAction
Function createPublishGithubPullRequestAction
createPublishGithubPullRequestAction
(
options
:
CreateGithubPullRequestActionOptions
,
)
:
TemplateAction
<
{
assignees
?:
string
[]
;
branchName
:
string
;
commitMessage
?:
string
;
createWhenEmpty
?:
boolean
;
description
:
string
;
draft
?:
boolean
;
filesToDelete
?:
string
[]
;
forceEmptyGitAuthor
?:
boolean
;
forceFork
?:
boolean
;
gitAuthorEmail
?:
string
;
gitAuthorName
?:
string
;
repoUrl
:
string
;
reviewers
?:
string
[]
;
sourcePath
?:
string
;
targetBranchName
?:
string
;
targetPath
?:
string
;
teamReviewers
?:
string
[]
;
title
:
string
;
token
?:
string
;
update
?:
boolean
;
}
,
{
pullRequestNumber
:
number
;
remoteUrl
:
string
;
targetBranchName
:
string
}
,
"v2"
,
>
Creates a Github Pull Request action.
Parameters
options
:
CreateGithubPullRequestActionOptions
Returns
TemplateAction
<
{
assignees
?:
string
[]
;
branchName
:
string
;
commitMessage
?:
string
;
createWhenEmpty
?:
boolean
;
description
:
string
;
draft
?:
boolean
;
filesToDelete
?:
string
[]
;
forceEmptyGitAuthor
?:
boolean
;
forceFork
?:
boolean
;
gitAuthorEmail
?:
string
;
gitAuthorName
?:
string
;
repoUrl
:
string
;
reviewers
?:
string
[]
;
sourcePath
?:
string
;
targetBranchName
?:
string
;
targetPath
?:
string
;
teamReviewers
?:
string
[]
;
title
:
string
;
token
?:
string
;
update
?:
boolean
;
}
,
{
pullRequestNumber
:
number
;
remoteUrl
:
string
;
targetBranchName
:
string
}
,
"v2"
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Docs
Github
Backstage
Loading...
Creates a Github Pull Request action.