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: {
    catalogClient: CatalogApi;
    integrations: ScmIntegrations;
    auth?: AuthService;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    catalogInfoUrl: string;
    optional?: boolean | undefined;
} | {
    repoContentsUrl: string;
    catalogInfoPath?: string | undefined;
    optional?: boolean | undefined;
}, import("@backstage/types").JsonObject>;

Parameters

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

Returns:

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

Parameters​

Parameters