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<{
    title: string;
    branchName: string;
    targetBranchName?: string;
    description: string;
    repoUrl: string;
    draft?: boolean;
    targetPath?: string;
    sourcePath?: string;
    token?: string;
    reviewers?: string[];
    teamReviewers?: string[];
    commitMessage?: string;
    update?: boolean;
    forceFork?: boolean;
    gitAuthorName?: string;
    gitAuthorEmail?: string;
    forceEmptyGitAuthor?: boolean;
    createWhenEmpty?: boolean;
}, import("@backstage/types").JsonObject, "v1">

Parameters

Parameter	Type	Description
options	CreateGithubPullRequestActionOptions

**Returns:**

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

Parameters​

Parameters