chore: add template for dynamic plugins #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Frank Kong <frkong@redhat.com>
Signed-off-by: Frank Kong <frkong@redhat.com>
davidfestal
reviewed
Dec 3, 2025
| import { version as frontendDynamicFeatureLoader } from '../../../frontend-dynamic-feature-loader/package.json'; | ||
| import { version as frontendPluginApi } from '../../../frontend-plugin-api/package.json'; | ||
| import { version as backendDefaults } from '../../../backend-defaults/package.json'; | ||
| import { version as backendDynamicFeatureService } from '../../../backend-dynamic-feature-service/package.json'; |
There was a problem hiding this comment.
When PR backstage#30967 is merged (hopefully), you would need to add the new @backstage/module-federation-common package introduced by this PR.
|
|
||
| ```bash | ||
| cd /path/to/your-frontend-plugin | ||
| yarn build --role frontend-dynamic-container |
There was a problem hiding this comment.
When PR backstage#30967 is merged (hopefully), we would be able to change this to yarn build --module-federation
packages/create-app/templates/dynamic-plugins-next-app/dynamic-plugins-root/README.md
Outdated
Show resolved
Hide resolved
packages/create-app/templates/dynamic-plugins-next-app/dynamic-plugins-root/README.md
Outdated
Show resolved
Hide resolved
packages/create-app/templates/dynamic-features-next-app/packages/backend/package.json.hbs
Outdated
Show resolved
Hide resolved
packages/create-app/templates/dynamic-features-next-app/packages/backend/package.json.hbs
Show resolved
Hide resolved
packages/create-app/templates/dynamic-features-next-app/packages/backend/package.json.hbs
Outdated
Show resolved
Hide resolved
packages/create-app/templates/dynamic-plugins-next-app/app-config.yaml.hbs
Show resolved
Hide resolved
packages/create-app/templates/dynamic-plugins-next-app/app-config.yaml.hbs
Outdated
Show resolved
Hide resolved
Signed-off-by: Frank Kong <frkong@redhat.com>
Signed-off-by: Frank Kong <frkong@redhat.com>
Signed-off-by: Frank Kong <frkong@redhat.com>
Signed-off-by: Frank Kong <frkong@redhat.com>
Signed-off-by: Frank Kong <frkong@redhat.com>
davidfestal
reviewed
Dec 15, 2025
|
|
||
| export default createApp({ | ||
| features: [ | ||
| catalogPlugin, |
There was a problem hiding this comment.
Didn't we conclude that we wanted to have:
- catalog,
- search,
- scaffolder,
- techdocs
- catalog-import ?
?
Comment on lines
26
to
32
| "@backstage/plugin-catalog": "^{{ version '@backstage/plugin-catalog'}}", | ||
| "@backstage/plugin-notifications": "^{{ version '@backstage/plugin-notifications'}}", | ||
| "@backstage/plugin-org": "^{{ version '@backstage/plugin-org'}}", | ||
| "@backstage/plugin-scaffolder": "^{{ version '@backstage/plugin-scaffolder'}}", | ||
| "@backstage/plugin-search": "^{{ version '@backstage/plugin-search'}}", | ||
| "@backstage/plugin-signals": "^{{ version '@backstage/plugin-signals'}}", | ||
| "@backstage/plugin-user-settings": "^{{ version '@backstage/plugin-user-settings'}}", |
packages/create-app/templates/dynamic-features-next-app/packages/app/README.md
Outdated
Show resolved
Hide resolved
Comment on lines
+15
to
+30
| To run the example frontend, first go to the project root and run | ||
|
|
||
| ```bash | ||
| yarn install | ||
| ``` | ||
|
|
||
| You should only need to do this once. | ||
|
|
||
| After that, go to the `packages/app` directory and run | ||
|
|
||
| ```bash | ||
| yarn start | ||
| ``` | ||
|
|
||
| The frontend starts up on port 3000 per default. | ||
| For more information on setting up the new frontend system, see the [Backstage documentation](https://backstage.io/docs/frontend-system/). |
There was a problem hiding this comment.
This is not really true.
With Dynamic plugins, the frontend should be started from the backend, in order to also inject the additional config schemas of the dynamic plugins.
Owner
Author
There was a problem hiding this comment.
Ah I guess I should just explicitly mention that dynamic plugins need the backend to be running to properly work as well.
packages/create-app/templates/dynamic-features-next-app/packages/backend/package.json.hbs
Outdated
Show resolved
Hide resolved
packages/create-app/templates/dynamic-features-next-app/packages/backend/README.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Frank Kong <frkong@redhat.com>
…mic-plugins-template
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey, I just made a Pull Request!
This PR introduces a new create-app template (dynamic-plugins-next-app) that scaffolds a Backstage application pre-configured with dynamic plugins support using the new frontend system and module federation.
Having a default template with dynamic plugins already setup is the first step in helping expose this feature to more users and make it easier for the community to experiment and contribute to this area.
The
frontend-dynamic-feature-loaderandbackend-dynamic-feature-servicewill function as no-op features when loaded without any configurations so this would not be a breaking change if the user ends up not using these features.How to test:
✔️ Checklist
Signed-off-byline in the message. (more info)