@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 content and places it in the workspace, or optionally in a subdirectory specified by the 'targetPath' input option. |
| 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. |
| createRouter(options) | A method to create a router for the scaffolder backend plugin. |
| createWaitAction(options) | Waits for a certain period of time. |
Interfaces
| Interface | Description |
|---|---|
| CreateBuiltInActionsOptions | The options passed to createBuiltinActions |
| CurrentClaimedTask | Stores the state of the current claimed task passed to the TaskContext |
| RouterOptions | RouterOptions |
| TaskStore | TaskStore |
Variables
| Variable | Description |
|---|---|
| createBuiltinActions | A function to generate create a list of default actions that the scaffolder provides. Is called internally in the default setup, but can be used when adding your own actions or overriding the default ones TODO(blam): version 2 of the scaffolder shouldn't ship with the additional modules. We should ship the basics, and let people install modules for the providers they want to use. |
| createFilesystemDeleteAction | Creates new action that enables deletion of files and directories in the workspace. |
| createFilesystemRenameAction | Creates a new action that allows renames of files and directories in the workspace. |
| createGithubActionsDispatchAction | |
| createGithubDeployKeyAction | |
| createGithubEnvironmentAction | |
| createGithubIssuesLabelAction | |
| createGithubRepoCreateAction | |
| createGithubRepoPushAction | |
| createGithubWebhookAction | |
| createPublishAzureAction | |
| createPublishBitbucketAction | |
| createPublishBitbucketCloudAction | |
| createPublishBitbucketServerAction | |
| createPublishBitbucketServerPullRequestAction | |
| createPublishGerritAction | |
| createPublishGerritReviewAction | |
| createPublishGithubAction | |
| createPublishGithubPullRequestAction | |
| createPublishGitlabAction | |
| createPublishGitlabMergeRequestAction | |
| createTemplateAction | |
| executeShellCommand | Run a command in a sub-process, normally a shell command. |
| fetchContents | A helper function that reads the contents of a directory from the given URL. Can be used in your own actions, and also used behind fetch:template and fetch:plain |
| ScaffolderEntitiesProcessor | Adds support for scaffolder specific entity kinds to the catalog. |