Skip to main content

createFetchCookiecutterAction()

Home > @backstage/plugin-scaffolder-backend-module-cookiecutter > createFetchCookiecutterAction

Creates a fetch:cookiecutter Scaffolder action.

Signature:

function createFetchCookiecutterAction(options: {
    reader: UrlReader;
    integrations: ScmIntegrations;
    containerRunner?: ContainerRunner;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    url: string;
    targetPath?: string | undefined;
    values: JsonObject;
    copyWithoutRender?: string[] | undefined;
    extensions?: string[] | undefined;
    imageName?: string | undefined;
}, JsonObject>;

Parameters​

ParameterTypeDescription
options{ reader: UrlReader; integrations: ScmIntegrations; containerRunner?: ContainerRunner; }Templating configuration.

Returns:

import("@backstage/plugin-scaffolder-node").TemplateAction<{ url: string; targetPath?: string | undefined; values: JsonObject; copyWithoutRender?: string[] | undefined; extensions?: string[] | undefined; imageName?: string | undefined; }, JsonObject>

Remarks​

See https://cookiecutter.readthedocs.io/ and https://backstage.io/docs/features/software-templates/writing-custom-actions.