Skip to main content

@backstage/plugin-scaffolder

Home > @backstage/plugin-scaffolder

The Backstage plugin that helps you create new things

Classes

ClassDescription
ScaffolderClientAn API to interact with the scaffolder backend.

Functions

FunctionDescription
makeFieldSchemaFromZod(returnSchema, uiOptionsSchema)Utility function to convert zod return and UI options schemas to a CustomFieldExtensionSchema with FieldExtensionComponentProps type inference

Interfaces

InterfaceDescription
FieldSchemaFieldSchema encapsulates a JSONSchema7 along with the matching FieldExtensionComponentProps type for a field extension.

Variables

VariableDescription
createScaffolderFieldExtension
createScaffolderLayout
EntityNamePickerFieldExtensionThe field extension for selecting a name for a new Entity in the Catalog.
EntityPickerFieldExtensionA field extension for selecting an Entity that exists in the Catalog.
EntityPickerFieldSchema
EntityTagsPickerFieldExtensionEntityTagsPickerFieldExtension
EntityTagsPickerFieldSchema
MultiEntityPickerFieldExtensionA field extension for selecting multiple entities that exists in the Catalog.
MyGroupsPickerFieldExtensionA field extension for picking groups a user belongs to out of the catalog.
MyGroupsPickerFieldSchemaField schema for the MyGroupsPicker.
MyGroupsPickerSchemaSchema for the MyGroupsPicker.
OwnedEntityPickerFieldExtensionA field extension to show all the Entities that are owned by the current logged-in User for use in templates.
OwnedEntityPickerFieldSchema
OwnerPickerFieldExtensionA field extension for picking users and groups out of the Catalog.
OwnerPickerFieldSchema
repoPickerValidationThe validation function for the repoUrl that is returned from the field extension. Ensures that you have all the required fields filled for the different providers that exist.
RepoUrlPickerFieldExtensionThe field extension which provides the ability to select a RepositoryUrl. Currently, this is an encoded URL that looks something like the following github.com?repo=myRepoName&owner=backstage.
RepoUrlPickerFieldSchema
rootRouteRef
scaffolderApiRef
ScaffolderFieldExtensions
ScaffolderLayouts
ScaffolderPageThe Router and main entrypoint to the Scaffolder plugin.
scaffolderPluginThe main plugin export for the scaffolder.
TaskPage
TemplateTypePickerThe component to select the type of Template that you will see in the table.
useTemplateSecrets

Type Aliases

Type AliasDescription
CustomFieldExtensionSchema
CustomFieldValidator
EntityPickerUiOptionsThe input props that can be specified under ui:options for the EntityPicker field extension.
EntityTagsPickerUiOptionsThe input props that can be specified under ui:options for the EntityTagsPicker field extension.
FieldExtensionComponent
FieldExtensionComponentProps
FieldExtensionOptions
LayoutOptions
LayoutTemplate
ListActionsResponse
LogEvent
MyGroupsPickerUiOptionsUI options for the MyGroupsPicker.
OwnedEntityPickerUiOptionsThe input props that can be specified under ui:options for the OwnedEntityPicker field extension.
OwnerPickerUiOptionsThe input props that can be specified under ui:options for the OwnerPicker field extension.
RepoUrlPickerUiOptionsThe input props that can be specified under ui:options for the RepoUrlPicker field extension.
RouterPropsThe Props for the Scaffolder Router
ScaffolderApi
ScaffolderDryRunOptions
ScaffolderDryRunResponse
ScaffolderGetIntegrationsListOptions
ScaffolderGetIntegrationsListResponse
ScaffolderOutputlink
ScaffolderScaffoldOptions
ScaffolderScaffoldResponse
ScaffolderStreamLogsOptions
ScaffolderTask
ScaffolderTaskOutput
ScaffolderTaskStatus
ScaffolderUseTemplateSecrets
TaskPagePropsTaskPageProps for constructing a TaskPage
TemplateParameterSchema