From 74fb539ac8dca357a986056fb86e3d9abc078269 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 2 Jul 2020 05:20:36 +0200 Subject: [PATCH] chore(scaffolder): fixing some docs --- .../src/scaffolder/stages/publish/types.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/publish/types.ts b/plugins/scaffolder-backend/src/scaffolder/stages/publish/types.ts index a6db297bde..17b357a4ef 100644 --- a/plugins/scaffolder-backend/src/scaffolder/stages/publish/types.ts +++ b/plugins/scaffolder-backend/src/scaffolder/stages/publish/types.ts @@ -17,7 +17,17 @@ import { TemplateEntityV1alpha1 } from '@backstage/catalog-model'; import { RequiredTemplateValues } from '../templater'; import { JsonValue } from '@backstage/config'; +/** + * Publisher is in charge of taking a folder created by + * the templater, and pushing it to a remote storage + */ export type Publisher = { + /** + * + * @param opts object containing the template entity from the service + * catalog, plus the values from the form and the directory that has + * been templated + */ publish(opts: { entity: TemplateEntityV1alpha1; values: RequiredTemplateValues & Record;