createGithubEnvironmentAction()

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

Creates an github:environment:create Scaffolder action that creates a Github Environment.

Signature:

function createGithubEnvironmentAction(options: {
    integrations: ScmIntegrationRegistry;
    catalogClient?: CatalogApi;
    auth?: AuthService;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    name: string;
    deploymentBranchPolicy?: {
        protected_branches: boolean;
        custom_branch_policies: boolean;
    };
    customBranchPolicyNames?: string[];
    customTagPolicyNames?: string[];
    environmentVariables?: {
        [key: string]: string;
    };
    secrets?: {
        [key: string]: string;
    };
    token?: string;
    waitTimer?: number;
    preventSelfReview?: boolean;
    reviewers?: string[];
}, import("@backstage/types").JsonObject, "v1">;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrationRegistry; catalogClient?: CatalogApi; auth?: AuthService; }

**Returns:**

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; name: string; deploymentBranchPolicy?: { protected_branches: boolean; custom_branch_policies: boolean; }; customBranchPolicyNames?: string[]; customTagPolicyNames?: string[]; environmentVariables?: { [key: string]: string; }; secrets?: { [key: string]: string; }; token?: string; waitTimer?: number; preventSelfReview?: boolean; reviewers?: string[]; }, import("@backstage/types").JsonObject, "v1">