createGithubBranchProtectionAction()

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

Creates an github:branch-protection:create Scaffolder action that configured Branch Protection in a Github Repository.

Signature:

function createGithubBranchProtectionAction(options: {
    integrations: ScmIntegrationRegistry;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    branch?: string;
    enforceAdmins?: boolean;
    requiredApprovingReviewCount?: number;
    requireCodeOwnerReviews?: boolean;
    dismissStaleReviews?: boolean;
    bypassPullRequestAllowances?: {
        users?: string[];
        teams?: string[];
        apps?: string[];
    } | undefined;
    restrictions?: {
        users: string[];
        teams: string[];
        apps?: string[];
    } | undefined;
    requiredStatusCheckContexts?: string[];
    requireBranchesToBeUpToDate?: boolean;
    requiredConversationResolution?: boolean;
    requireLastPushApproval?: boolean;
    requiredCommitSigning?: boolean;
    requiredLinearHistory?: boolean;
    token?: string;
}, import("@backstage/types").JsonObject, "v1">;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrationRegistry; }

**Returns:**

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

Parameters​

Parameters