cli: add local linking of backend packages too

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-10-22 12:54:41 +02:00
parent df231cf395
commit d2e166cbb2
5 changed files with 41 additions and 11 deletions
@@ -22,7 +22,6 @@ instance of Backstage.
:::info
Workspace linking is an experimental feature and may not work in all cases.
It currently only works for frontend packages.
:::
The `backstage-cli package start` command that is used for local development of all packages supports a `--link` flag that can be used to link a single external workspace to the current workspace. It hooks into the module resolution and will override all imports of packages in the linked workspace to be imported from there instead. The only exception are the `react` and `react-dom` packages, which will always be resolved from the target package.
@@ -39,6 +38,8 @@ The path provided to the `--link` option can be a relative or absolute path, and
With the `start` command up and running and serving the development version of your frontend app in the browser, you can now make changes to both workspaces and see the changes reflected in the browser.
You can also link backend packages using the exact same process, simply start your backend package with the same `--link <workspace-path>` option.
## Common Problems
### React errors