createPublishGithubAction()

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

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

Signature:

function createPublishGithubAction(options: {
    integrations: ScmIntegrationRegistry;
    config: Config;
    githubCredentialsProvider?: GithubCredentialsProvider;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    description?: string;
    homepage?: string;
    access?: string;
    defaultBranch?: string;
    protectDefaultBranch?: boolean;
    protectEnforceAdmins?: boolean;
    deleteBranchOnMerge?: boolean;
    gitCommitMessage?: string;
    gitAuthorName?: string;
    gitAuthorEmail?: string;
    allowRebaseMerge?: boolean;
    allowSquashMerge?: boolean;
    squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
    squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
    allowMergeCommit?: boolean;
    allowAutoMerge?: boolean;
    allowUpdateBranch?: boolean;
    sourcePath?: string;
    bypassPullRequestAllowances?: {
        users?: string[];
        teams?: string[];
        apps?: string[];
    } | undefined;
    requiredApprovingReviewCount?: number;
    restrictions?: {
        users: string[];
        teams: string[];
        apps?: string[];
    } | undefined;
    requireCodeOwnerReviews?: boolean;
    dismissStaleReviews?: boolean;
    requiredStatusCheckContexts?: string[];
    requireBranchesToBeUpToDate?: boolean;
    requiredConversationResolution?: boolean;
    requireLastPushApproval?: boolean;
    repoVisibility?: "private" | "internal" | "public";
    collaborators?: Array<{
        user: string;
        access: string;
    } | {
        team: string;
        access: string;
    } | {
        username: string;
        access: "pull" | "push" | "admin" | "maintain" | "triage";
    }>;
    hasProjects?: boolean | undefined;
    hasWiki?: boolean | undefined;
    hasIssues?: boolean | undefined;
    token?: string;
    topics?: string[];
    repoVariables?: {
        [key: string]: string;
    };
    secrets?: {
        [key: string]: string;
    };
    oidcCustomization?: {
        useDefault: boolean;
        includeClaimKeys?: string[];
    };
    requiredCommitSigning?: boolean;
    requiredLinearHistory?: boolean;
    customProperties?: {
        [key: string]: string;
    };
    subscribe?: 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; homepage?: string; access?: string; defaultBranch?: string; protectDefaultBranch?: boolean; protectEnforceAdmins?: boolean; deleteBranchOnMerge?: boolean; gitCommitMessage?: string; gitAuthorName?: string; gitAuthorEmail?: string; allowRebaseMerge?: boolean; allowSquashMerge?: boolean; squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; allowMergeCommit?: boolean; allowAutoMerge?: boolean; allowUpdateBranch?: boolean; sourcePath?: string; bypassPullRequestAllowances?: { users?: string[]; teams?: string[]; apps?: string[]; } | undefined; requiredApprovingReviewCount?: number; restrictions?: { users: string[]; teams: string[]; apps?: string[]; } | undefined; requireCodeOwnerReviews?: boolean; dismissStaleReviews?: boolean; requiredStatusCheckContexts?: string[]; requireBranchesToBeUpToDate?: boolean; requiredConversationResolution?: boolean; requireLastPushApproval?: boolean; repoVisibility?: "private" | "internal" | "public"; collaborators?: Array<{ user: string; access: string; } | { team: string; access: string; } | { username: string; access: "pull" | "push" | "admin" | "maintain" | "triage"; }>; hasProjects?: boolean | undefined; hasWiki?: boolean | undefined; hasIssues?: boolean | undefined; token?: string; topics?: string[]; repoVariables?: { [key: string]: string; }; secrets?: { [key: string]: string; }; oidcCustomization?: { useDefault: boolean; includeClaimKeys?: string[]; }; requiredCommitSigning?: boolean; requiredLinearHistory?: boolean; customProperties?: { [key: string]: string; }; subscribe?: boolean; }, import("@backstage/types").JsonObject, "v1">