@backstage/plugin-scaffolder-backend

Home > @backstage/plugin-scaffolder-backend

The Backstage backend plugin that helps you create new things

Classes

Class	Description
DatabaseTaskStore	DatabaseTaskStore
TaskManager	TaskManager
TaskWorker	TaskWorker
TemplateActionRegistry	Registry of all registered template actions.

Functions

Function	Description
createCatalogRegisterAction(options)	Registers entities from a catalog descriptor file in the workspace into the software catalog.
createCatalogWriteAction()	Writes a catalog descriptor file containing the provided entity to a path in the workspace.
createDebugLogAction()	Writes a message into the log or lists all files in the workspace
createFetchCatalogEntityAction(options)	Returns entity or entities from the catalog by entity reference(s).
createFetchPlainAction(options)	Downloads content and places it in the workspace, or optionally in a subdirectory specified by the 'targetPath' input option.
createFetchPlainFileAction(options)	Downloads a single file and places it in the workspace.
createFetchTemplateAction(options)	Downloads a skeleton, templates variables into file and directory names and content. Then places the result in the workspace, or optionally in a subdirectory specified by the 'targetPath' input option.
createFetchTemplateFileAction(options)	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.
createFilesystemDeleteAction()	Creates new action that enables deletion of files and directories in the workspace.
createFilesystemReadDirAction()	Creates new action that enables reading directories in the workspace.
createFilesystemRenameAction()	Creates a new action that allows renames of files and directories in the workspace.
createWaitAction(options)	Waits for a certain period of time.

Interfaces

Interface	Description
CurrentClaimedTask	Stores the state of the current claimed task passed to the TaskContext
TaskStore	TaskStore

Variables

Variable	Description
scaffolderPlugin	Scaffolder plugin

Type Aliases

Type Alias	Description
ActionPermissionRuleInput
CreateWorkerOptions	CreateWorkerOptions
DatabaseTaskStoreOptions	DatabaseTaskStore
TaskStoreCreateTaskOptions	The options passed to TaskStore.createTask()
TaskStoreCreateTaskResult	The response from TaskStore.createTask()
TaskStoreEmitOptions	TaskStoreEmitOptions
TaskStoreListEventsOptions	TaskStoreListEventsOptions
TaskStoreRecoverTaskOptions	The options passed to TaskStore.recoverTasks()
TaskStoreShutDownTaskOptions	TaskStoreShutDownTaskOptions
TemplatePermissionRuleInput