Skip to main content
Version: Next

createFetchTemplateFileAction()

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

Downloads a single file and templates variables into file. Then places the result in the workspace, or optionally in a subdirectory specified by the 'targetPath' input option.

Signature:

function createFetchTemplateFileAction(options: {
reader: UrlReaderService;
integrations: ScmIntegrations;
additionalTemplateFilters?: Record<string, TemplateFilter>;
additionalTemplateGlobals?: Record<string, TemplateGlobal>;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
url: string;
targetPath: string;
values: any;
cookiecutterCompat?: boolean | undefined;
replace?: boolean | undefined;
trimBlocks?: boolean | undefined;
lstripBlocks?: boolean | undefined;
token?: string | undefined;
}, import("@backstage/types").JsonObject>;

Parameters

Parameter

Type

Description

options

{ reader: UrlReaderService; integrations: ScmIntegrations; additionalTemplateFilters?: Record<string, TemplateFilter>; additionalTemplateGlobals?: Record<string, TemplateGlobal>; }

**Returns:**

import("@backstage/plugin-scaffolder-node").TemplateAction<{ url: string; targetPath: string; values: any; cookiecutterCompat?: boolean | undefined; replace?: boolean | undefined; trimBlocks?: boolean | undefined; lstripBlocks?: boolean | undefined; token?: string | undefined; }, import("@backstage/types").JsonObject>