@backstage/plugin-scaffolder-common

Home > @backstage/plugin-scaffolder-common

Common functionalities for the scaffolder, to be shared between scaffolder and scaffolder-backend plugin

Classes

Class	Description
ScaffolderClient	An API to interact with the scaffolder backend.

Functions

Function	Description
isTemplateEntityV1beta3(entity)	Typeguard for filtering entities and ensuring v1beta3 entities

Interfaces

Interface	Description
ScaffolderApi	An API to interact with the scaffolder backend.
ScaffolderDryRunOptions
ScaffolderDryRunResponse
ScaffolderGetIntegrationsListOptions	The arguments for getIntegrationsList.
ScaffolderGetIntegrationsListResponse	The response shape for getIntegrationsList.
ScaffolderRequestOptions	Options you can pass into a Scaffolder request for additional information.
ScaffolderScaffoldOptions	The input options to the scaffold method of the ScaffolderClient.
ScaffolderScaffoldResponse	The response shape of the scaffold method of the ScaffolderClient.
ScaffolderStreamLogsOptions	The input options to the streamLogs method of the ScaffolderClient.
TaskRecovery	When task didn't have a chance to complete due to system restart you can define the strategy what to do with such tasks, by defining a strategy. By default, it is none, what means to not recover but updating the status from 'processing' to 'failed'.
TaskSpecV1beta3	A scaffolder task as stored in the database, generated from a v1beta3 apiVersion Template.
TaskStep	An individual step of a scaffolder task, as stored in the database.
TemplateEntityStepV1beta3	Step that is part of a Template Entity.
TemplateEntityV1beta3	Backstage catalog Template kind Entity. Templates are used by the Scaffolder plugin to create new entities, such as Components.
TemplateParametersV1beta3	Parameter that is part of a Template Entity.
TemplatePermissionsV1beta3	Access control properties for parts of a template.
TemplatePresentationV1beta3	The presentation of the template.
TemplateRecoveryV1beta3	Depends on how you designed your task you might tailor the behaviour for each of them.

Variables

Variable	Description
templateEntityV1beta3Validator	Entity data validator for TemplateEntityV1beta3.

Type Aliases

Type Alias	Description
Action	The response shape for a single action in the listActions call to the scaffolder-backend
ListActionsResponse	The response shape for the listActions call to the scaffolder-backend
ListTemplatingExtensionsResponse	The response shape for the listTemplatingExtensions call to the scaffolder-backend
LogEvent	The shape of a LogEvent message from the scaffolder-backend
ScaffolderOutputLink
ScaffolderOutputText
ScaffolderTask	The shape of each task returned from the scaffolder-backend
ScaffolderTaskOutput
ScaffolderTaskStatus
ScaffolderUsageExample	A single scaffolder usage example
TaskEventType
TaskRecoverStrategy	none - not recover, let the task be marked as failed startOver - do recover, start the execution of the task from the first step.
TaskSpec	A scaffolder task as stored in the database, generated from a Template.
TemplateFilter	The response shape for a single filter in the listTemplatingExtensions call to the scaffolder-backend
TemplateGlobalFunction	The response shape for a single global function in the listTemplatingExtensions call to the scaffolder-backend
TemplateGlobalValue	The response shape for a single global value in the listTemplatingExtensions call to the scaffolder-backend
TemplateInfo	Information about a template that is stored on a task specification. Includes a stringified entityRef, and the baseUrl which is usually the relative path of the template definition
TemplateParameterSchema	The shape of each entry of parameters which gets rendered as a separate step in the wizard input