Version: Next

createCatalogRegisterAction()

Home > @backstage/plugin-scaffolder-backend > createCatalogRegisterAction

Registers entities from a catalog descriptor file in the workspace into the software catalog.

Signature:

function createCatalogRegisterAction(options: {
    catalog: CatalogService;
    integrations: ScmIntegrations;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    catalogInfoUrl: string;
    optional?: boolean | undefined;
} | {
    catalogInfoUrl: string;
    optional?: boolean | undefined;
    catalogInfoPath?: string | undefined;
} | {
    repoContentsUrl: string;
    optional?: boolean | undefined;
} | {
    repoContentsUrl: string;
    optional?: boolean | undefined;
    catalogInfoPath?: string | undefined;
}, {
    [x: string]: any;
}, "v2">;

Parameters

Parameter	Type	Description
options	{ catalog: CatalogService; integrations: ScmIntegrations; }

Returns:

import("@backstage/plugin-scaffolder-node").TemplateAction<{ catalogInfoUrl: string; optional?: boolean | undefined; } | { catalogInfoUrl: string; optional?: boolean | undefined; catalogInfoPath?: string | undefined; } | { repoContentsUrl: string; optional?: boolean | undefined; } | { repoContentsUrl: string; optional?: boolean | undefined; catalogInfoPath?: string | undefined; }, { [x: string]: any; }, "v2">

Parameters​

Parameters