Backstage Changelog

This is a best-effort changelog where we manually collect breaking changes. It is not an exhaustive list of all changes or even features added.

If you encounter issues while upgrading to a newer version, don't hesitate to reach out on Discord or open an issue!

Next Release

Collect changes for the next release below

Material-UI: Bumped to 4.11.0, which is the version that create-app will resolve to, because we wanted to get the renaming of ExpansionPanel to Accordion into place. This gets rid of a lot of console deprecation warnings in newly scaffolded apps.
The backend plugin service builder no longer adds express.json() automatically to all routes. While convenient in a lot of cases, it also led to problems where for example the proxy middleware could hang because the body had already been altered and could not be streamed. Also, plugins that rather wanted to handle e.g. form encoded data still had to cater to that manually. We therefore decided to let plugins add express.json() themselves if they happen to deal with JSON data.

Includes https://github.com/spotify/backstage/pull/2097 to resolve issues with create-plugin command.

Many plugins have been added to the catalog and will for now be required to be added to separate apps as well. This will be solved as #1536 gets sorted out, but for now you may need to install some plugins just to get pages to work.

Added the possibility to add static locations via app-config.yaml. This changed the signature of new LocationReaders(logger) inside packages/backend/src/plugins/catalog.ts to new LocationReaders({config, logger}). #1890

Changed the type signature of the palette, removing sidebar: string and adding navigation: { background: string; indicator: string}. #1880

Fixed an issue with duplicated location logs. Applying the database migrations from this fix will clear the existing migration logs. #1836

This version fixes a breakage in CSP policies set by the auth backend. If you're facing trouble with auth in alpha.17, upgrade to alpha.18.

OAuth redirect URLs no longer receive the env parameter, as it is now passed through state instead. This will likely require a reconfiguration of the OAuth app, where a redirect URL like http://localhost:7000/auth/google/handler/frame?env=development should now be configured as http://localhost:7000/auth/google/handler/frame. #1812

SignInPage props have been changed to receive a list of provider objects instead of simple string identifiers for all but the 'guest' and 'custom' providers. This opens up for configuration of custom providers, but may break existing configurations. See packages/app/src/App.tsx and packages/app/src/identityProviders.ts for how to bring back the existing providers. #1816

The techdocs backend now requires more configuration to be supplied when creating the router. See packages/backend/src/plugins/techdocs.ts for an example. #1736

The create-app command was moved out from the CLI to a standalone package. It's now invoked with npx @backstage/create-app instead. #1745