Version: Next

createPublishGithubPullRequestAction()

Home > @backstage/plugin-scaffolder-backend-module-github > createPublishGithubPullRequestAction

Creates a Github Pull Request action.

Signature:

createPublishGithubPullRequestAction: (options: CreateGithubPullRequestActionOptions) => import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    branchName: string;
    title: string;
    description: string;
    targetBranchName?: string | undefined;
    draft?: boolean | undefined;
    sourcePath?: string | undefined;
    targetPath?: string | undefined;
    token?: string | undefined;
    reviewers?: string[] | undefined;
    assignees?: string[] | undefined;
    teamReviewers?: string[] | undefined;
    commitMessage?: string | undefined;
    update?: boolean | undefined;
    forceFork?: boolean | undefined;
    gitAuthorName?: string | undefined;
    gitAuthorEmail?: string | undefined;
    forceEmptyGitAuthor?: boolean | undefined;
    createWhenEmpty?: boolean | undefined;
}, {
    targetBranchName: string;
    remoteUrl: string;
    pullRequestNumber: number;
}, "v2">

Parameters

Parameter	Type	Description
options	CreateGithubPullRequestActionOptions

**Returns:**

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; branchName: string; title: string; description: string; targetBranchName?: string | undefined; draft?: boolean | undefined; sourcePath?: string | undefined; targetPath?: string | undefined; token?: string | undefined; reviewers?: string[] | undefined; assignees?: string[] | undefined; teamReviewers?: string[] | undefined; commitMessage?: string | undefined; update?: boolean | undefined; forceFork?: boolean | undefined; gitAuthorName?: string | undefined; gitAuthorEmail?: string | undefined; forceEmptyGitAuthor?: boolean | undefined; createWhenEmpty?: boolean | undefined; }, { targetBranchName: string; remoteUrl: string; pullRequestNumber: number; }, "v2">

Parameters​

Parameters