paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity

From: Alan Serhan <alan.serhan@fmr.com>

Browse Source 
Date: Fri, 17 May 2024 16:56:00 IST
Subject: [Feature] Update Backstage docs to include information how to leverage backstage-cli

Signed-off-by: Alan Serhan <alan.serhan@fmr.com>
This commit is contained in:
Alan Serhan
2024-05-17 16:52:39 +01:00
parent 0a7b369cd3
commit 9189c23b65
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-templates/writing-custom-actions.md
+19
View File
@@ -13,6 +13,25 @@ by writing custom actions which can be used alongside our
> If you want to continue using the builtin actions, include them in the actions
> array when registering your custom actions, as seen below.
## Streamlining Custom Action Creation with Backstage CLI
The creation of custom actions in Backstage has never been easier thanks to the Backstage CLI. This tool streamlines the setup process, allowing you to focus on your actions' unique functionality.
Start by using the `yarn backstage-cli new` command to generate a scaffolder module. This command sets up the necessary boilerplate code, providing a smooth start:
```
$ yarn backstage-cli new
? What do you want to create?
plugin-common - A new isomorphic common plugin package
plugin-node - A new Node.js library plugin package
plugin-react - A new web library plugin package
> scaffolder-module - An module exporting custom actions for @backstage/plugin-scaffolder-backend
```
You can find a [list](https://backstage.io/docs/local-dev/cli-commands/) of all commands provided by the Backstage CLI.
When prompted, select the option to generate a scaffolder module. This creates a solid foundation for your custom action. Enter the name of the module you wish to create, and the CLI will generate the required files and directory structure.
## Writing your Custom Action
Your custom action can live where you choose, but simplest is to include it