Version: Next

createGithubRepoCreateAction()

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

Creates a new action that initializes a git repository

Signature:

function createGithubRepoCreateAction(options: {
    integrations: ScmIntegrationRegistry;
    githubCredentialsProvider?: GithubCredentialsProvider;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    description?: string;
    homepage?: string;
    access?: string;
    deleteBranchOnMerge?: boolean;
    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;
    requireCodeOwnerReviews?: boolean;
    bypassPullRequestAllowances?: {
        users?: string[];
        teams?: string[];
        apps?: string[];
    };
    requiredApprovingReviewCount?: number;
    restrictions?: {
        users: string[];
        teams: string[];
        apps?: string[];
    };
    requiredStatusCheckContexts?: string[];
    requireBranchesToBeUpToDate?: boolean;
    requiredConversationResolution?: 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;
    hasWiki?: boolean;
    hasIssues?: boolean;
    token?: string;
    topics?: string[];
    repoVariables?: {
        [key: string]: string;
    };
    secrets?: {
        [key: string]: string;
    };
    oidcCustomization?: {
        useDefault: boolean;
        includeClaimKeys?: string[];
    };
    requireCommitSigning?: boolean;
    requiredLinearHistory?: boolean;
    customProperties?: {
        [key: string]: string;
    };
    subscribe?: boolean;
}, import("@backstage/types").JsonObject, "v1">;

Parameters

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

**Returns:**

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; description?: string; homepage?: string; access?: string; deleteBranchOnMerge?: boolean; 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; requireCodeOwnerReviews?: boolean; bypassPullRequestAllowances?: { users?: string[]; teams?: string[]; apps?: string[]; }; requiredApprovingReviewCount?: number; restrictions?: { users: string[]; teams: string[]; apps?: string[]; }; requiredStatusCheckContexts?: string[]; requireBranchesToBeUpToDate?: boolean; requiredConversationResolution?: 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; hasWiki?: boolean; hasIssues?: boolean; token?: string; topics?: string[]; repoVariables?: { [key: string]: string; }; secrets?: { [key: string]: string; }; oidcCustomization?: { useDefault: boolean; includeClaimKeys?: string[]; }; requireCommitSigning?: boolean; requiredLinearHistory?: boolean; customProperties?: { [key: string]: string; }; subscribe?: boolean; }, import("@backstage/types").JsonObject, "v1">

Parameters​

Parameters