@backstage/plugin-scaffolder

Home > @backstage/plugin-scaffolder

The Backstage plugin that helps you create new things

Classes

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

Functions

Function	Description
makeFieldSchemaFromZod(returnSchema, uiOptionsSchema)
repoPickerValidation(value, validation, context)	The 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.
ScaffolderPage(props)	The Router and main entrypoint to the Scaffolder plugin.
TaskPage(props)
TemplateTypePicker()	The component to select the type of Template that you will see in the table.
useTemplateSecrets()

Interfaces

Interface	Description
FieldSchema

Variables

Variable	Description
createScaffolderFieldExtension
createScaffolderLayout
EntityNamePickerFieldExtension	The field extension for selecting a name for a new Entity in the Catalog.
EntityPickerFieldExtension	A field extension for selecting an Entity that exists in the Catalog.
EntityPickerFieldSchema
EntityTagsPickerFieldExtension	EntityTagsPickerFieldExtension
EntityTagsPickerFieldSchema
MultiEntityPickerFieldExtension	A field extension for selecting multiple entities that exists in the Catalog.
MyGroupsPickerFieldExtension	A field extension for picking groups a user belongs to out of the catalog.
MyGroupsPickerFieldSchema	Field schema for the MyGroupsPicker.
MyGroupsPickerSchema	Schema for the MyGroupsPicker.
OwnedEntityPickerFieldExtension	A field extension to show all the Entities that are owned by the current logged-in User for use in templates.
OwnedEntityPickerFieldSchema
OwnerPickerFieldExtension	A field extension for picking users and groups out of the Catalog.
OwnerPickerFieldSchema
RepoBranchPickerFieldExtension	A field extension to select a branch from a repository.
RepoUrlPickerFieldExtension	The 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
scaffolderPlugin	The main plugin export for the scaffolder.

Type Aliases

Type Alias	Description
CustomFieldExtensionSchema
CustomFieldValidator
EntityPickerUiOptions	The input props that can be specified under ui:options for the EntityPicker field extension.
EntityTagsPickerUiOptions	The input props that can be specified under ui:options for the EntityTagsPicker field extension.
FieldExtensionComponent
FieldExtensionComponentProps
FieldExtensionOptions
LayoutOptions
LayoutTemplate
ListActionsResponse
LogEvent
MyGroupsPickerUiOptions	UI options for the MyGroupsPicker.
OwnedEntityPickerUiOptions	The input props that can be specified under ui:options for the OwnedEntityPicker field extension.
OwnerPickerUiOptions	The input props that can be specified under ui:options for the OwnerPicker field extension.
RepoUrlPickerUiOptions	The input props that can be specified under ui:options for the RepoUrlPicker field extension.
RouterProps	The Props for the Scaffolder Router
ScaffolderApi
ScaffolderDryRunOptions
ScaffolderDryRunResponse
ScaffolderGetIntegrationsListOptions
ScaffolderGetIntegrationsListResponse
ScaffolderOutputlink
ScaffolderScaffoldOptions
ScaffolderScaffoldResponse
ScaffolderStreamLogsOptions
ScaffolderTask
ScaffolderTaskOutput
ScaffolderTaskStatus
ScaffolderUseTemplateSecrets
TaskPageProps	TaskPageProps for constructing a TaskPage
TemplateParameterSchema