@backstage/plugin-scaffolder-common
Home > @backstage/plugin-scaffolder-common
Common functionalities for the scaffolder, to be shared between scaffolder and scaffolder-backend plugin
Interfaces
Interface | Description |
---|---|
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 |
---|---|
isTemplateEntityV1beta3 | Typeguard for filtering entities and ensuring v1beta3 entities |
templateEntityV1beta3Validator | Entity data validator for TemplateEntityV1beta3. |
Type Aliases
Type Alias | Description |
---|---|
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. |
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 |