Skip to main content

createFetchRailsAction()

Home > @backstage/plugin-scaffolder-backend-module-rails > createFetchRailsAction

Creates the fetch:rails Scaffolder action.

Signature:

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

Parameters​

ParameterTypeDescription
options{ reader: UrlReader; integrations: ScmIntegrations; containerRunner?: ContainerRunner; allowedImageNames?: string[]; }Configuration of the templater.

Returns:

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

Remarks​

See https://guides.rubyonrails.org/rails_application_templates.html and https://backstage.io/docs/features/software-templates/writing-custom-actions.