Version: Next

createGithubRepoPushAction()

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

Creates a new action that initializes a git repository of the content in the workspace and publishes it to GitHub.

Signature:

function createGithubRepoPushAction(options: {
    integrations: ScmIntegrationRegistry;
    config: Config;
    githubCredentialsProvider?: GithubCredentialsProvider;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    description?: string;
    defaultBranch?: string;
    protectDefaultBranch?: boolean;
    protectEnforceAdmins?: boolean;
    gitCommitMessage?: string;
    gitAuthorName?: string;
    gitAuthorEmail?: string;
    requireCodeOwnerReviews?: boolean;
    dismissStaleReviews?: boolean;
    bypassPullRequestAllowances?: {
        users?: string[];
        teams?: string[];
        apps?: string[];
    } | undefined;
    requiredApprovingReviewCount?: number;
    restrictions?: {
        users: string[];
        teams: string[];
        apps?: string[];
    } | undefined;
    requiredStatusCheckContexts?: string[];
    requireBranchesToBeUpToDate?: boolean;
    requiredConversationResolution?: boolean;
    sourcePath?: string;
    token?: string;
    requiredCommitSigning?: boolean;
    requiredLinearHistory?: boolean;
    requireLastPushApproval?: boolean;
}, import("@backstage/types").JsonObject, "v1">;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrationRegistry; config: Config; githubCredentialsProvider?: GithubCredentialsProvider; }

**Returns:**

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; description?: string; defaultBranch?: string; protectDefaultBranch?: boolean; protectEnforceAdmins?: boolean; gitCommitMessage?: string; gitAuthorName?: string; gitAuthorEmail?: string; requireCodeOwnerReviews?: boolean; dismissStaleReviews?: boolean; bypassPullRequestAllowances?: { users?: string[]; teams?: string[]; apps?: string[]; } | undefined; requiredApprovingReviewCount?: number; restrictions?: { users: string[]; teams: string[]; apps?: string[]; } | undefined; requiredStatusCheckContexts?: string[]; requireBranchesToBeUpToDate?: boolean; requiredConversationResolution?: boolean; sourcePath?: string; token?: string; requiredCommitSigning?: boolean; requiredLinearHistory?: boolean; requireLastPushApproval?: boolean; }, import("@backstage/types").JsonObject, "v1">

Parameters​

Parameters