Skip to content

CHANGELOG.md

Latest commit

 

History

History
163 lines (89 loc) · 12 KB

CHANGELOG.md

File metadata and controls

163 lines (89 loc) · 12 KB

Backstage Changelog

This changelog is no longer being updated and will be removed in the future, as each package now has its own changelog instead. It was a best-effort changelog where we manually collected breaking changes during the v0.1.1-alpha.<n> releases.

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

v0.1.1-alpha.26

@backstage/cli

  • Configuration files are no longer selected through APP_ENV or NODE_ENV. The default configuration files are app-config.yaml and, fix it exists, app-config.local.yaml in the repo root. To load a different set of files, use --config <path> arguments.

@backstage/backend-common

  • Configuration files are no longer selected through APP_ENV or NODE_ENV. The default configuration files are app-config.yaml and, fix it exists, app-config.local.yaml in the repo root. To load a different set of files, use --config <path> arguments.

v0.1.1-alpha.25

@backstage/cli

  • The recommended way to set the configuration environment is now to use APP_ENV instead of NODE_ENV.

Backend (example-backend, or backends created with @backstage/create-app)

v0.1.1-alpha.24

Backend (example-backend, or backends created with @backstage/create-app)

  • The default mount point for backend plugins have been changed to /api. These changes are done in the backend package itself, so it is recommended that you sync up existing backend packages with this new pattern. #2562
  • A service discovery mechanism for backend plugins has been added, and is now a requirement for several backend plugins. See packages/backend/src/index.ts for how to set it up using SingleHostDiscovery from @backstage/backend-common. Note that the default base path for plugins is set to /api to that change, but it can be set to use the old behavior via the basePath option. #2600

@backstage/auth-backend

  • The default mount path of backend plugins was changed to /api/:pluginId, and as part of that it was needed to enable configuration of the base path of the auth backend, so that it can construct redirect URLs correctly. Note that you will also need to reconfigure any allowed redirect URLs to include /api if you switch to the new recommended pattern. #2562
  • The auth backend now requires an implementation of PluginEndpointDiscovery from @backstage/backend-common to be passed in as discovery. See the changes to @backstage/backend.

@backstage/proxy-backend

  • The proxy backend now requires an implementation of PluginEndpointDiscovery from @backstage/backend-common to be passed in as discovery. See the changes to @backstage/backend.

@backstage/techdocs-backend

  • The TechDocs backend now requires an implementation of PluginEndpointDiscovery from @backstage/backend-common to be passed in as discovery. See the changes to @backstage/backend.

@backstage/plugin-identity-backend

  • This plugin was removed, remove it from your backend if it's there. #2616

v0.1.1-alpha.23

@backstage/core

  • Renamed SessionStateApi to SessionApi and logout to signOut. Custom implementations of the SingInPage app-component will need to rename their logout function. The different auth provider items for the UserSettingsMenu have been consolidated into a single ProviderSettingsItem, meaning you need to replace existing usages of OAuthProviderSettings and OIDCProviderSettings. #2555.

v0.1.1-alpha.22

@backstage/core

  • Introduced initial version of an inverted app/plugin relationship, where plugins export components for apps to use, instead registering themselves directly into the app. This enables more fine-grained control of plugin features, and also composition of plugins such as catalog pages with additional cards and tabs. This breaks the use of RouteRefs, and there will be more changes related to this in the future, but this change lays the initial foundation. See packages/app and followup PRs for how to update plugins for this change. #2076
  • Switch to an automatic dependency injection mechanism for all Utility APIs, allowing plugins to ship default implementations of their APIs. See https://backstage.io/docs/api/utility-apis. #2285

@backstage/cli

  • Change backstage-cli backend:build-image to forward all args to docker image build, instead of just tag. Also add --build flag for building all dependent packages before packaging the workspace for the docker build. #2299

@backstage/create-app

  • Change root tsc output dir to dist-types, in order to allow for standalone plugin repos. #2278

@backstage/catalog-backend

  • We have simplified the way that GitHub ingestion works. The catalog.processors.githubApi key is deprecated, in favor of catalog.processors.github. At the same time, the location type github/api is likewise deprecated, in favor of github. This location type now serves both raw HTTP reads and APIv3 reads, depending on how you configure it. It also supports having several providers at once - for example, both public GitHub and an internal GitHub Enterprise, with different keys. If you still use the catalog.processors.githubApi config key, things will work but you will get a deprecation warning at startup. In a later release, support for the old key will go away entirely. See the configuration section in the docs for more details.

v0.1.1-alpha.21

  • Added many more frontend plugins to the template along with the sidebar. #1942, #2084

@backstage/core

  • 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.

@backstage/cli

  • Set NODE_ENV to test when running test. #2214

  • Fix for backend plugins names requiring to be prefixed with @backstage to build. #2224

@backstage/backend-common

  • 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.

@backstage/catalog-backend

  • Add rules configuration for catalog location and entity kinds. The default rules should cover most use-cases, but you may need to allow specific entity kinds when using things like Template or Group entities. #2118

v0.1.1-alpha.20

@backstage/cli

  • Use config files according to NODE_ENV when serving and building frontend packages. #2077

  • Pin rollup-plugin-dts to avoid a later broken version. #2097

v0.1.1-alpha.19

@backstage/backend-common

  • Allow listen host and port to be configured separately, in order to support PORT environment variables. #1950

@backstage/core

  • Added new DiscoveryApi for discovering backend endpoint in the frontend, and use in most plugins. See packages/app/src/apis.ts for how to register in your app. #2074

@backstage/create-app

  • Added catalog and scaffolder frontend plugins to the template along with the sidebar. #1942, #2084
  • 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.

@backstage/catalog-backend

  • 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

@backstage/theme

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

v0.1.1-alpha.18

@backstage/catalog-backend

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

@backstage/auth-backend

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

@backstage/core

  • 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

v0.1.1-alpha.17

@backstage/techdocs-backend

@backstage/cli

  • 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
⚡