Version: Next

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;
    } | undefined;
    customBranchPolicyNames?: string[] | undefined;
    customTagPolicyNames?: string[] | undefined;
    environmentVariables?: {
        [key: string]: string;
    } | undefined;
    secrets?: {
        [key: string]: string;
    } | undefined;
    token?: string | undefined;
    waitTimer?: number | undefined;
    preventSelfReview?: boolean | undefined;
    reviewers?: string[] | undefined;
}, import("@backstage/types").JsonObject>;

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; } | undefined; customBranchPolicyNames?: string[] | undefined; customTagPolicyNames?: string[] | undefined; environmentVariables?: { [key: string]: string; } | undefined; secrets?: { [key: string]: string; } | undefined; token?: string | undefined; waitTimer?: number | undefined; preventSelfReview?: boolean | undefined; reviewers?: string[] | undefined; }, import("@backstage/types").JsonObject>

Parameters​

Parameters