Releases · backstage/backstage

These are the release notes for the v1.38.0 release of Backstage.

A huge thanks to the whole team of maintainers and contributors as well as the amazing Backstage Community for the hard work in getting this release developed and done.

Highlights

BREAKING: Removal of `React` imports

Backstage projects now ship with the new JSX transforms enabled by default, which removes the need for any default React imports. They are not yet included in the common configuration in the CLI, but you can enable them in your own project by adding the following under "compilerOptions" in your tsconfig.json: "jsx": "react-jsx".

To go along with this change the ESLint configuration in @backstage/cli has a new set of rules that produces warnings if React default imports are used. We recommend all adopters to switch to the new JSX transforms at their earliest convenience.

For more information, see the JSX transform migration guide.

Contributed by @schultzp2020 in #29499

BREAKING: Github Integration Changes

The @backstage/plugin-catalog-backend-module-github now will reject any configuration that contains slashes in branch names. Branches with slashes in Backstage are currently unsupported (#2815), and allowing this would cause issues after ingestion.

Contributed by @lukealbao in #29424

Another breaking change is that the @backstage/plugin-scaffolder-backend-module-github module also now will use the default branch of main instead of master when publishing new repositories.

It can be configured to any other value from the default by using the defaultBranch input.

    - id: publish
      name: Publish
      action: publish:github
      input:
        allowedHosts: ['github.com']
        description: This is ${{ parameters.name }}
        repoUrl: ${{ parameters.repoUrl }}
+       defaultBranch: 'master'

Contributed by @QuadmanSWE in #29488

BREAKING: Translation key changes for Scaffolder Plugin

Some translations have changed the key that they are nested under as they have been refactored into a better place with the upcoming additions of createTemplateGlobal and createTemplateFilter.

This means that the translation keys have changed for actionsPage.content.tableCell.*. They have moved to their own root key renderSchema.* instead.

Contributed by @mbenson in #29383

`backstage-cli repo start`

In order to align on yarn start being the only command needed for local development, we’ve introduced a new repo start command to the backstage-cli for use in the root package.json.

This will allow users to just run yarn start in the root of the repository. It will run the app and/or backend package in the repository by default, but you can also select packages to run by name or path, as well as run plugin dev entry points by plugin ID. For more information on the available options, see the docs for the repo start command.

The new script is installed as follows, replacing the existing yarn start script:

{
  "scripts": {
    "start": "backstage-cli repo start"
  }
}

In order to help users migrate in existing projects, it is recommended to replace existing scripts with the following in the root package.json:

{
  "scripts": {
    "dev": "echo \"Use 'yarn start' instead\"",
    "start-backend": "echo \"Use 'yarn start backend' instead\""
  }
}

New plugin drop: 📦 Gateway Plugin

We have released @backstage/plugin-gateway-backend, a plugin for managing request routing in distributed Backstage deployments. This plugin is designed for organizations that have split their backend plugins across multiple Backstage deployments.

The gateway plugin addresses frontend-to-backend routing by providing a centralized routing solution in a dedicated "gateway" Backstage deployment. It routes frontend requests to the appropriate backend plugins using the Discovery service, while prioritizing local plugins when available.

Canon 0.3.0

Our new design system Canon has reached 0.3.0 in this release. You can read more about the changes in the canon changelog.

Movement towards Module Federation support

The new package @backstage/frontend-dynamic-features-loader provides a frontend feature loader that dynamically
loads frontend features based on the new frontend system and exposed as module federation remotes.
This new frontend feature loader works hand-in-hand with a new server of frontend plugin module federation
remotes, which is added as part of backend dynamic feature service in package @backstage/backend-dynamic-feature-service.

Contributed by @davidfestal in #28076

Catalog Events support for `bitbucket-server`

One of the oldest PRs that we had has finally been merged! We now have support for Bitbucket Server events, to automatically react to file changes to keep the catalog up to date.

Thanks for the effort from all involved to finally get this across the line 🎉

Contributed by @davelil4 in #19633

Redis clustering support

You can now enable Redis clustering, through the backend.cache.redis.cluster key.

Contributed by @marknach in #29162

Support for SRV look-ups in standard discovery

You can now use URLs on for example the form http+srv://recordname/api/{{pluginId}} in discovery.endpoints[].target.internal, to get automatic real-time SRV resolution of your internal deployments.

Send Slack notifications from the events system

There’s now a Slack processor for the notifications subsystem. Get notified right in your Slack workspace when things happen.

Contributed by @kunickiaj in #29308

New Frontend System Improvements

It is now possible to add custom header menu items to the entity page, see the example below:

import { EntityContextMenuItemBlueprint } from '@backstage/plugin-catalog-react/alpha';

const customEntityMenuItem = EntityContextMenuItemBlueprint.make({
  name: 'custom-entity-menu-item',
  params: {
    icon: <ExampleIcon />,
    useProps() {
      // Other hooks can be called here
      return {
        title: 'Example title',
        href: '/example-path', // or onClick: () => window.alert('Hello world!'),
        disabled: false,
      };
    },
  },
});

Contributed by @marknotfound in #29515

Massive appreciation to the 55 amazing contributors who made this release possible by merging 188 pull requests: @acierto, @aladjadj, @alex-mckay, @AmbrishRamachandiran, @aramissennyeydd, @awanlin, @benjdlambert, @benjidotsh, @BethGriggs, @BingeCode, @camilaibs, @carlosmonastyrski, @cdedreuille, @davidfestal, @deepthi-28, @djamaile, @drodil, @Erob711, @fengypants, @freben, @its-mitesh-kumar, @jboeijenga, @JeevaRamanathan, @JohannesWill, @johnphilip283, @jpbottinelli, @knowacki23, @kunickiaj, @lavanya-sainik-ericsson, @lukealbao, @marians, @mario-mui, @marknotfound, @mbenson, @nasyrov-r, @Naycon, @nBerg, @Parsifal-M, @patroswastik, @PeaWarrior, @pmckl, @punkle, @QuadmanSWE, @rpasaporte, @Rugvip, @schultzp2020, @secustor, @squid-ney, @tklever, @tylerd-canva, @UsainBloot, @vinzscam, @vitasek01, @wrighbr, @YuvalFireFly.

Security Fixes

This release contains a security improvement that addresses potential information leakage of policies within the permission system.

Upgrade path

We recommend that you keep your Backstage project up to date with this latest release. For more guidance on how to upgrade, check out the documentation for keeping Backstage updated.