createPublishGitlabAction()

Home > @backstage/plugin-scaffolder-backend-module-gitlab > createPublishGitlabAction

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

Signature:

function createPublishGitlabAction(options: {
    integrations: ScmIntegrationRegistry;
    config: Config;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    defaultBranch?: string;
    repoVisibility?: "private" | "internal" | "public";
    sourcePath?: string | boolean;
    skipExisting?: boolean;
    token?: string;
    gitCommitMessage?: string;
    gitAuthorName?: string;
    gitAuthorEmail?: string;
    signCommit?: boolean;
    setUserAsOwner?: boolean;
    topics?: string[];
    settings?: {
        path?: string;
        auto_devops_enabled?: boolean;
        ci_config_path?: string;
        description?: string;
        merge_method?: "merge" | "rebase_merge" | "ff";
        squash_option?: "default_off" | "default_on" | "never" | "always";
        topics?: string[];
        visibility?: "private" | "internal" | "public";
        only_allow_merge_if_all_discussions_are_resolved?: boolean;
        only_allow_merge_if_pipeline_succeeds?: boolean;
        allow_merge_on_skipped_pipeline?: boolean;
    };
    branches?: Array<{
        name: string;
        protect?: boolean;
        create?: boolean;
        ref?: string;
    }>;
    projectVariables?: Array<{
        key: string;
        value: string;
        description?: string;
        variable_type?: string;
        protected?: boolean;
        masked?: boolean;
        raw?: boolean;
        environment_scope?: string;
    }>;
}, import("@backstage/types").JsonObject, "v1">;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrationRegistry; config: Config; }

**Returns:**

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; defaultBranch?: string; repoVisibility?: "private" | "internal" | "public"; sourcePath?: string | boolean; skipExisting?: boolean; token?: string; gitCommitMessage?: string; gitAuthorName?: string; gitAuthorEmail?: string; signCommit?: boolean; setUserAsOwner?: boolean; topics?: string[]; settings?: { path?: string; auto_devops_enabled?: boolean; ci_config_path?: string; description?: string; merge_method?: "merge" | "rebase_merge" | "ff"; squash_option?: "default_off" | "default_on" | "never" | "always"; topics?: string[]; visibility?: "private" | "internal" | "public"; only_allow_merge_if_all_discussions_are_resolved?: boolean; only_allow_merge_if_pipeline_succeeds?: boolean; allow_merge_on_skipped_pipeline?: boolean; }; branches?: Array<{ name: string; protect?: boolean; create?: boolean; ref?: string; }>; projectVariables?: Array<{ key: string; value: string; description?: string; variable_type?: string; protected?: boolean; masked?: boolean; raw?: boolean; environment_scope?: string; }>; }, import("@backstage/types").JsonObject, "v1">

Parameters​

Parameters