diff --git a/plugins/scaffolder/README.md b/plugins/scaffolder/README.md index 8acf456b08..0a79d8afc0 100644 --- a/plugins/scaffolder/README.md +++ b/plugins/scaffolder/README.md @@ -120,6 +120,15 @@ export const apis: AnyApiFactory[] = [ This replaces the default implementation of the `scaffolderApiRef`. +### Local development + +When you develop a new template, action or new ``, then we recommend +to launch the plugin locally using the `createDevApp` of the `./dev/index.tsx` file for testing/Debugging purposes + +To play with it, open a terminal and run the command: `yarn start` within the `./plugins/scaffolder` folder + +**NOTE:** Don't forget to open a second terminal and to launch the backend or [backend-next](../../docs/backend-system/index.md) there, using `yarn start` and to specify the locations of the templates to play with ! + ## Links - [scaffolder-backend](https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend) diff --git a/plugins/scaffolder/dev/index.tsx b/plugins/scaffolder/dev/index.tsx index ebc0c3596f..625e29629c 100644 --- a/plugins/scaffolder/dev/index.tsx +++ b/plugins/scaffolder/dev/index.tsx @@ -14,11 +14,9 @@ * limitations under the License. */ -import { CatalogClient } from '@backstage/catalog-client'; import { createDevApp } from '@backstage/dev-utils'; import { scmIntegrationsApiRef } from '@backstage/integration-react'; import { - catalogApiRef, starredEntitiesApiRef, MockStarredEntitiesApi, } from '@backstage/plugin-catalog-react'; @@ -31,18 +29,10 @@ import { fetchApiRef, identityApiRef, } from '@backstage/core-plugin-api'; -import { CatalogEntityPage } from '@backstage/plugin-catalog'; +import { CatalogEntityPage, catalogPlugin } from '@backstage/plugin-catalog'; createDevApp() - .addPage({ - path: '/catalog/:kind/:namespace/:name', - element: , - }) - .registerApi({ - api: catalogApiRef, - deps: { discoveryApi: discoveryApiRef }, - factory: ({ discoveryApi }) => new CatalogClient({ discoveryApi }), - }) + .registerPlugin(catalogPlugin) .registerApi({ api: starredEntitiesApiRef, deps: {}, @@ -64,6 +54,10 @@ createDevApp() identityApi, }), }) + .addPage({ + path: '/catalog/:kind/:namespace/:name', + element: , + }) .addPage({ path: '/create', title: 'Create',