Johan Persson
bfc5acd0c6
Add all exported sub-components to the Component type union so changelog entries referencing them are resolved correctly. Update ChangelogComponent to accept an array of components, showing scoped badges when filtering by multiple components. Update 13 component pages to include their sub-components in the changelog section. Signed-off-by: Johan Persson <johanopersson@gmail.com>
Backstage UI Docs
Backstage UI is our internal UI library built for Backstage. We built this website to document the library and its components. You can view this website here.
How to run locally
This website is built with Next.js and it is hosted on Github pages. To run it locally, you can run the following command:
yarn start
Deployment
Deployments are done automatically when a PR is merged into the master branch. We host the website using Github pages.
Maintaining Component Changelogs
After a @backstage/ui release, sync the component changelogs to keep documentation up-to-date:
yarn sync:changelog
This script:
- Parses
packages/ui/CHANGELOG.mdfor new versions - Extracts entries tagged with "Affected components: ..."
- Updates
src/utils/changelog.tswith new entries - Handles both component-specific and general package changes
After running, review the changes in src/utils/changelog.ts and commit them.
Preview changes before writing:
yarn sync:changelog:dry-run
Running this gives you a summary of what would be written, without actually adding or changing any files.