Release v1.20.0
@backstage/backend-openapi-utils@0.1.0
Minor Changes
- 785fb1ea75: Adds a new route,
/openapi.json
to validated routers for displaying their full OpenAPI spec in a standard endpoint.
Patch Changes
- 6694b369a3: Adds a new function
wrapInOpenApiTestServer
that allows for proxied requests at runtime. This will support the newyarn backstage-repo-tools schema openapi test
command. - Updated dependencies
- @backstage/backend-plugin-api@0.6.7
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
@backstage/cli@0.24.0
Minor Changes
- 8db5c3cd7a: Removed support for the
publishConfig.alphaTypes
and.betaTypes
fields that were used together with--experimental-type-build
to generate/alpha
and/beta
entry points. Use theexports
field to achieve this instead. - 4e36abef14: Remove support for the deprecated
--experimental-type-build
option forpackage build
.
Patch Changes
- 4ba4ac351f: Switch from using deprecated
@esbuild-kit/*
packages to usingtsx
. This also switches to using the new module loaderregister
API when available, avoiding the experimental warning when starting backends. - cd80ebb062: Updated dependency
vite-plugin-node-polyfills
to^0.16.0
. - 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - 971dcba764: Updated dependency
@typescript-eslint/eslint-plugin
to6.10.0
. - 6bf7561d3c: The experimental package detection will now ignore packages that don't make
package.json
available. - e14cbf563d: Added
EXPERIMENTAL_VITE
flag for using vite as dev server instead of Webpack - 7cd34392f5: Ignore
stdin
when spawning backend child process for thestart
command. Fixing an issue where backend startup would hang. - Updated dependencies
- @backstage/config-loader@1.5.3
- @backstage/cli-node@0.2.0
- @backstage/integration@1.7.2
- @backstage/release-manifests@0.0.11
- @backstage/catalog-model@1.4.3
- @backstage/cli-common@0.1.13
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/eslint-plugin@0.1.3
- @backstage/types@1.1.1
@backstage/cli-node@0.2.0
Minor Changes
- 8db5c3cd7a: Removed support for the
publishConfig.alphaTypes
and.betaTypes
fields that were used together with--experimental-type-build
to generate/alpha
and/beta
entry points. Use theexports
field to achieve this instead.
Patch Changes
- Updated dependencies
- @backstage/cli-common@0.1.13
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
@backstage/core-plugin-api@1.8.0
Minor Changes
- 1e5b7d993a:
IconComponent
can now have afontSize
ofinherit
, which is useful for in-line icons. - cb6db75bc2: Introduced
AnyRouteRefParams
as a replacement forAnyParams
, which is now deprecated.
Patch Changes
- 6c2b872153: Add official support for React 18.
- cb6db75bc2: Deprecated several types related to the routing system that are scheduled to be removed, as well as several fields on the route ref types themselves.
- 68fc9dc60e: Added a new
/alpha
exportconvertLegacyRouteRef
, which is a temporary utility to allow existing route refs to be used with the new experimental packages. - Updated dependencies
- @backstage/version-bridge@1.0.7
- @backstage/config@1.1.1
- @backstage/types@1.1.1
@backstage/frontend-app-api@0.3.0
Minor Changes
- 68fc9dc60e: Added the ability to configure bound routes through
app.routes.bindings
. The routing system used bycreateApp
has been replaced by one that only supports route refs of the new format from@backstage/frontend-plugin-api
. The requirement for route refs to have the same ID as their associated extension has been removed.
Patch Changes
- e28d379e32: Refactor internal extension instance system into an app graph.
- fdc348d5d3: The options parameter of
createApp
is now optional. - 6c2b872153: Add official support for React 18.
- dc613f9bcf: Updated
app.extensions
configuration schema. - 733bd95746: Implement new
AppTreeApi
- 685a4c8901: Installed features are now deduplicated both by reference and ID when available. Features passed to
createApp
now override both discovered and loaded features. - fa28d4e6df: No longer throw error on invalid input if the child is disabled.
- bb98953cb9: Register default implementation for the
Translation API
on the newcreateApp
. - fe6d09953d: Fix for app node output IDs not being serialized correctly.
- 77f009b35d: Internal updates to match changes in the experimental
@backstage/frontend-plugin-api
. - 4d6fa921db: Internal refactor to rename the app graph to app tree
- Updated dependencies
- @backstage/core-components@0.13.8
- @backstage/frontend-plugin-api@0.3.0
- @backstage/plugin-graphiql@0.3.0
- @backstage/core-plugin-api@1.8.0
- @backstage/version-bridge@1.0.7
- @backstage/core-app-api@1.11.1
- @backstage/theme@0.4.4
- @backstage/config@1.1.1
- @backstage/types@1.1.1
@backstage/frontend-plugin-api@0.3.0
Minor Changes
- 68fc9dc60e: Added
RouteRef
,SubRouteRef
,ExternalRouteRef
, and related types. All exports from this package that previously relied on the types with the same name from@backstage/core-plugin-api
now use the new types instead. To convert and existing legacy route ref to be compatible with the APIs from this package, use theconvertLegacyRouteRef
utility from@backstage/core-plugin-api/alpha
. - 77f009b35d: Extensions now return their output from the factory function rather than calling
bind(...)
.
Patch Changes
- 6c2b872153: Add official support for React 18.
- 733bd95746: Add new
AppTreeApi
. - 6af88a05ff: Improve the extension boundary component and create a default extension suspense component.
- Updated dependencies
- @backstage/core-components@0.13.8
- @backstage/core-plugin-api@1.8.0
- @backstage/version-bridge@1.0.7
- @backstage/types@1.1.1
@backstage/repo-tools@0.4.0
Minor Changes
-
4e36abef14: Remove support for the deprecated
--experimental-type-build
option forpackage build
. -
6694b369a3: Adds a new command
schema openapi test
that performs runtime validation of your OpenAPI specs using your test data. Under the hood, we're using Optic to perform this check, really cool work by them!To use this new command, you will have to run
yarn add @useoptic/optic
in the root of your repo.
Patch Changes
- Updated dependencies
- @backstage/cli-node@0.2.0
- @backstage/catalog-model@1.4.3
- @backstage/cli-common@0.1.13
- @backstage/errors@1.2.3
@techdocs/cli@1.7.0
Minor Changes
- 8600b86820: validate Docker status before running mkdocs server
Patch Changes
- Updated dependencies
- @backstage/plugin-techdocs-node@1.10.0
- @backstage/backend-common@0.19.9
- @backstage/catalog-model@1.4.3
- @backstage/cli-common@0.1.13
- @backstage/config@1.1.1
@backstage/plugin-api-docs@0.10.0
Minor Changes
- 0ac0e10822: Replace GraphiQL playground with DocExplorer
- 62310404b7: Define a default for oauth2RedirectUrl option of swagger-ui-react to match documentation
Patch Changes
- 6c2b872153: Add official support for React 18.
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - 613a55911f: Updated dependency
graphiql
to3.0.9
. - 4ad15278e6: Updated dependency
@graphiql/react
to^0.20.0
. - 62b5922916: Internal theme type updates
- Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/plugin-catalog@1.15.0
- @backstage/core-plugin-api@1.8.0
- @backstage/theme@0.4.4
- @backstage/catalog-model@1.4.3
@backstage/plugin-auth-backend@0.20.0
Minor Changes
- bdf08ad04a: Adds the StaticTokenIssuer and StaticKeyStore, an alternative token issuer that can be used to sign the Authorization header using a predefined public/private key pair.
Patch Changes
- 243c655a68: JSDoc and Error message updates to handle
Azure Active Directory
re-brand toEntra ID
- 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - f2fc5acca6: Added an optional
additionalScopes
configuration parameter tookta
providers, that lets you add additional scopes on top of the default ones. - 96c4f54bf6: Reverted the Microsoft auth provider to the previous implementation.
- Updated dependencies
- @backstage/plugin-catalog-node@1.5.0
- @backstage/plugin-auth-backend-module-gitlab-provider@0.1.4
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/catalog-client@1.4.6
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-auth-backend-module-gcp-iap-provider@0.2.1
- @backstage/plugin-auth-backend-module-github-provider@0.1.4
- @backstage/plugin-auth-backend-module-google-provider@0.1.4
- @backstage/plugin-auth-backend-module-oauth2-provider@0.1.4
- @backstage/plugin-auth-node@0.4.1
@backstage/plugin-catalog@1.15.0
Minor Changes
- 1e5b7d993a: Added the
DefaultEntityPresentationApi
, which is an implementation of theEntityPresentationApi
that@backstage/plugin-catalog-react
exposes through itsentityPresentationApiRef
. This implementation is also by default made available automatically by the catalog plugin, unless you replace it with a custom one. It batch fetches and caches data from the catalog as needed for display, and is customizable by adopters to add their own rendering functions.
Patch Changes
-
eb817ee6d4: Fix spacing inconsistency with links and labels in headers
-
8a8445663b: Migrate catalog entity cards to new frontend system extension format.
-
e964c17db9: Use default extensions boundary and suspense on the alpha declarative
createCatalogFilterExtension
extension factory. -
71c97e7d73: The `spec.lifecycle' field in entities will now always be rendered as a string.
-
6c2b872153: Add official support for React 18.
-
0bf6ebda88: Initial entity page implementation for new frontend system at
/alpha
, with an overview page enabled by default and the about card available as an optional card. -
bb98953cb9: Create declarative extensions for the
Catalog
plugin; this initial plugin preset contains sidebar item, index page and filter extensions, all distributed via/alpha
subpath.The
EntityPage
will be migrated in a follow-up patch. -
7c265b9758: Fix type error on
CatalogTable
when using Material UI v5 -
69c14904b6: Use
EntityRefLinks
withhideIcons
property to avoid double icons -
62b5922916: Internal theme type updates
-
77f009b35d: Internal updates to match changes in the experimental
@backstage/frontend-plugin-api
. -
Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/frontend-plugin-api@0.3.0
- @backstage/plugin-scaffolder-common@1.4.3
- @backstage/integration-react@1.1.21
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-search-react@1.7.2
- @backstage/theme@0.4.4
- @backstage/catalog-client@1.4.6
- @backstage/catalog-model@1.4.3
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-catalog-common@1.0.18
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-catalog-backend@1.15.0
Minor Changes
-
e5bf3749ad: Support adding location analyzers in new catalog analysis extension point and move
AnalyzeOptions
andScmLocationAnalyzer
types to@backstage/plugin-catalog-node
-
8d756968f9: Introduce a new optional config parameter
catalog.stitchingStrategy.mode
, which can have the values'immediate'
(default) and'deferred'
. The default is for stitching to work as it did before this change, which means that it happens "in-band" (blocking) immediately when each processing task finishes. When set to'deferred'
, stitching is instead deferred to happen on a separate asynchronous worker queue just like processing.Deferred stitching should make performance smoother when ingesting large amounts of entities, and reduce p99 processing times and repeated over-stitching of hot spot entities when fan-out/fan-in in terms of relations is very large. It does however also come with some performance cost due to the queuing with how much wall-clock time some types of task take.
Patch Changes
- 6694b369a3: Update the OpenAPI spec with more complete error responses and request bodies using Optic. Also, updates the test cases to use the new
supertest
pass through from@backstage/backend-openapi-utils
. - 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - Updated dependencies
- @backstage/plugin-catalog-node@1.5.0
- @backstage/integration@1.7.2
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-tasks@0.5.12
- @backstage/catalog-client@1.4.6
- @backstage/plugin-permission-common@0.7.10
- @backstage/backend-openapi-utils@0.1.0
- @backstage/plugin-search-backend-module-catalog@0.1.11
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-auth-node@0.4.1
- @backstage/plugin-catalog-common@1.0.18
- @backstage/plugin-events-node@0.2.16
- @backstage/plugin-permission-node@0.7.18
@backstage/plugin-catalog-backend-module-backstage-openapi@0.1.0
Minor Changes
- 785fb1ea75: Adds a new catalog module for ingesting Backstage plugin OpenAPI specs into the catalog for display as an API entity.
Patch Changes
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - Updated dependencies
- @backstage/plugin-catalog-node@1.5.0
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-tasks@0.5.12
- @backstage/backend-openapi-utils@0.1.0
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
@backstage/plugin-catalog-graph@0.3.0
Minor Changes
-
a604623324: Add the entire
Entity
toEntityNodeData
and deprecatename
,kind
,title
,namespace
andspec
.To get the deprecated properties in your custom component you can use:
import { DEFAULT_NAMESPACE } from '@backstage/catalog-model';
const {
kind,
metadata: { name, namespace = DEFAULT_NAMESPACE, title },
} = entity;
Patch Changes
- 6c2b872153: Add official support for React 18.
- 62b5922916: Internal theme type updates
- Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/core-plugin-api@1.8.0
- @backstage/theme@0.4.4
- @backstage/catalog-client@1.4.6
- @backstage/catalog-model@1.4.3
- @backstage/types@1.1.1
@backstage/plugin-catalog-node@1.5.0
Minor Changes
- e5bf3749ad: Support adding location analyzers in new catalog analysis extension point and move
AnalyzeOptions
andScmLocationAnalyzer
types to@backstage/plugin-catalog-node
Patch Changes
- Updated dependencies
- @backstage/backend-plugin-api@0.6.7
- @backstage/catalog-client@1.4.6
- @backstage/catalog-model@1.4.3
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-catalog-common@1.0.18
@backstage/plugin-catalog-react@1.9.0
Minor Changes
-
1e5b7d993a: Added an
EntityPresentationApi
and associatedentityPresentationApiRef
. This API lets you control how references to entities (e.g. in links, headings, iconography etc) are represented in the user interface.Usage of this API is initially added to the
EntityRefLink
andEntityRefLinks
components, so that they can render richer, more correct representation of entity refs. There's also a newEntityDisplayName
component, which works just like theEntityRefLink
but without the link.Along with that change, the
fetchEntities
andgetTitle
props ofEntityRefLinksProps
are deprecated and no longer used, since the same need instead is fulfilled (and by default always enabled) by theentityPresentationApiRef
. -
1fd53fa0c6: The
UserListPicker
component has undergone improvements to enhance its performance.The previous implementation inferred the number of owned and starred entities based on the entities available in the
EntityListContext
. The updated version no longer relies on theEntityListContext
for inference, allowing for better decoupling.The component now loads the entities' count asynchronously, resulting in improved performance and responsiveness. For this purpose, some of the exported filters such as
EntityTagFilter
,EntityOwnerFilter
,EntityLifecycleFilter
andEntityNamespaceFilter
have now thegetCatalogFilters
method implemented.
Patch Changes
- 2ad1bacef7: Add EntityRef to Entity Inspector UI
- 6c2b872153: Add official support for React 18.
- 69ee8d75f4: Remove
button
prop from used MaterialUIMenuItem
component fixing incompatibility with MaterialUI v5. - 0bf6ebda88: Added new APIs at the
/alpha
subpath for creating entity page cards and content for the new frontend system. - 77f009b35d: Internal updates to match changes in the experimental
@backstage/frontend-plugin-api
. - 71c97e7d73: The
spec.type
field in entities will now always be rendered as a string. - 69c14904b6: Move the
EntityRefLink
icon to the left hand side as per Material-UI guidelines - 000dcd01af: Removed unnecessary
@backstage/integration
dependency, replaced by@backstage/integration-react
. - 6c357184e2: Export
MissingAnnotationEmptyState
from@backstage/plugin-catalog-react
- Updated dependencies
- @backstage/core-components@0.13.8
- @backstage/frontend-plugin-api@0.3.0
- @backstage/integration-react@1.1.21
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-permission-react@0.4.17
- @backstage/version-bridge@1.0.7
- @backstage/theme@0.4.4
- @backstage/catalog-client@1.4.6
- @backstage/plugin-permission-common@0.7.10
- @backstage/catalog-model@1.4.3
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-catalog-common@1.0.18
@backstage/plugin-graphiql@0.3.0
Minor Changes
- 57fda44b90: Upgrade to GraphiQL to 3.0.6
Patch Changes
- 68fc9dc60e: Updated alpha exports according to routing changes in
@backstage/frontend-plugin-api
. - 6c2b872153: Add official support for React 18.
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - 77f009b35d: Internal updates to match changes in the experimental
@backstage/frontend-plugin-api
. - Updated dependencies
- @backstage/core-components@0.13.8
- @backstage/frontend-plugin-api@0.3.0
- @backstage/core-plugin-api@1.8.0
- @backstage/theme@0.4.4
@backstage/plugin-playlist@0.2.0
Minor Changes
-
f0e2ef3b81: Support being able to define custom composable Playlist index pages
BREAKING The individual
PlaylistPage
route must now be manually hooked up by making the following change to your setup:-import { PlaylistIndexPage } from '@backstage/plugin-playlist';
+import { PlaylistIndexPage, PlaylistPage } from '@backstage/plugin-playlist';
// ...
<Route path="/playlist" element={<PlaylistIndexPage />} />
+<Route path="/playlist/:playlistId" element={<PlaylistPage />} />
Patch Changes
- 6c2b872153: Add official support for React 18.
- 69ee8d75f4: Remove
button
prop from used MaterialUIMenuItem
component fixing incompatibility with MaterialUI v5. - 62b5922916: Internal theme type updates
- Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-permission-react@0.4.17
- @backstage/plugin-search-react@1.7.2
- @backstage/theme@0.4.4
- @backstage/plugin-permission-common@0.7.10
- @backstage/catalog-model@1.4.3
- @backstage/errors@1.2.3
- @backstage/plugin-catalog-common@1.0.18
- @backstage/plugin-playlist-common@0.1.12
@backstage/plugin-scaffolder@1.16.0
Minor Changes
-
f28c11743a: Add a possibility to use a formatter on a warning panel. Applied it for a scaffolder template
-
3fdffbb699: Release design improvements for the
Scaffolder
plugin and support v5 of@rjsf/*
libraries.This change should be non-breaking. If you're seeing typescript issues after migrating please open an issue
The
next
versions likecreateNextFieldExtension
andNextScaffolderPage
have been promoted to the public interface undercreateScaffolderFieldExtension
andScaffolderPage
, so any older imports which are no longer found will need updating from@backstage/plugin-scaffolder/alpha
or@backstage/plugin-scaffolder-react/alpha
will need to be imported from@backstage/plugin-scaffolder
and@backstage/plugin-scaffolder-react
respectively.The legacy versions are now available in
/alpha
undercreateLegacyFieldExtension
andLegacyScaffolderPage
if you're running into issues, but be aware that these will be removed in a next mainline release.
Patch Changes
- 6c2b872153: Add official support for React 18.
- 69ee8d75f4: Remove
button
prop from used MaterialUIMenuItem
component fixing incompatibility with MaterialUI v5. - c838da0edd: Updated dependency
@rjsf/utils
to5.13.6
. Updated dependency@rjsf/core
to5.13.6
. Updated dependency@rjsf/material-ui
to5.13.6
. Updated dependency@rjsf/validator-ajv8
to5.13.6
. - 26e4d916d5: Title and description in RepoUrlPicker are now correctly displayed.
- 69c14904b6: Use
EntityRefLinks
withhideIcons
property to avoid double icons - 62b5922916: Internal theme type updates
- Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/plugin-scaffolder-common@1.4.3
- @backstage/integration@1.7.2
- @backstage/integration-react@1.1.21
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-permission-react@0.4.17
- @backstage/plugin-scaffolder-react@1.6.0
- @backstage/theme@0.4.4
- @backstage/catalog-client@1.4.6
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-catalog-common@1.0.18
@backstage/plugin-scaffolder-backend@1.19.0
Minor Changes
-
f3ab9cfcb7: Made shut down stale tasks configurable.
There are two properties exposed:
scaffolder.processingInterval
- sets the processing interval for staled tasks.scaffolder.taskTimeoutJanitorFrequency
- sets the task's heartbeat timeout, when to consider a task to be staled.
-
7d5a921114: Allow using
globby
's negative matching withcopyWithoutTemplating
/copyWithoutRender
. This allows including an entire subdirectory while excluding a single file so that it will still be templated instead of needing to list every other file and ensure the list is updated when new files are added. -
5e4127c18e: Allow setting
update: true
inpublish:github:pull-request
scaffolder action
Patch Changes
- 0920fd02ac: Add examples for
github:environment:create
scaffolder action & improve related tests - ae30a9ae8c: Added description for publish:gerrit scaffolder actions
- 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - 23f72b2cba: Refactoring the runner to generate minimally informative task log per iteration and properly validate iterated actions.
- 8613ba3928: Switched to using
"exports"
field for/alpha
subpath export. - 99d4936f6c: Add examples for
github:webhook
scaffolder action & improve related tests - 2be3922eb8: Add examples for
github:deployKey:create
scaffolder action & improve related tests - 76d07da66a: Make it possible to define control buttons text (Back, Create, Review) per template
- f8727ad228: Add examples for
publish:github:pull-request
scaffolder action & improve related tests - Updated dependencies
- @backstage/plugin-catalog-backend@1.15.0
- @backstage/plugin-catalog-node@1.5.0
- @backstage/plugin-scaffolder-common@1.4.3
- @backstage/integration@1.7.2
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-tasks@0.5.12
- @backstage/catalog-client@1.4.6
- @backstage/plugin-permission-common@0.7.10
- @backstage/plugin-scaffolder-node@0.2.8
- @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.4
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-auth-node@0.4.1
- @backstage/plugin-catalog-common@1.0.18
- @backstage/plugin-permission-node@0.7.18
@backstage/plugin-scaffolder-react@1.6.0
Minor Changes
-
3fdffbb699: Release design improvements for the
Scaffolder
plugin and support v5 of@rjsf/*
libraries.This change should be non-breaking. If you're seeing typescript issues after migrating please open an issue
The
next
versions likecreateNextFieldExtension
andNextScaffolderPage
have been promoted to the public interface undercreateScaffolderFieldExtension
andScaffolderPage
, so any older imports which are no longer found will need updating from@backstage/plugin-scaffolder/alpha
or@backstage/plugin-scaffolder-react/alpha
will need to be imported from@backstage/plugin-scaffolder
and@backstage/plugin-scaffolder-react
respectively.The legacy versions are now available in
/alpha
undercreateLegacyFieldExtension
andLegacyScaffolderPage
if you're running into issues, but be aware that these will be removed in a next mainline release.
Patch Changes
- 6c2b872153: Add official support for React 18.
- 171a99816b: Fixed
backstage:featureFlag
inscaffolder/next
by sorting outmanifest.steps
. - c838da0edd: Updated dependency
@rjsf/utils
to5.13.6
. Updated dependency@rjsf/core
to5.13.6
. Updated dependency@rjsf/material-ui
to5.13.6
. Updated dependency@rjsf/validator-ajv8
to5.13.6
. - 69c14904b6: Use
EntityRefLinks
withhideIcons
property to avoid double icons - 62b5922916: Internal theme type updates
- dda56ae265: Preserve step's time execution for a non-running task.
- 76d07da66a: Make it possible to define control buttons text (Back, Create, Review) per template
- Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/plugin-scaffolder-common@1.4.3
- @backstage/core-plugin-api@1.8.0
- @backstage/version-bridge@1.0.7
- @backstage/theme@0.4.4
- @backstage/catalog-client@1.4.6
- @backstage/catalog-model@1.4.3
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
@backstage/plugin-search-backend-module-stack-overflow-collator@0.1.0
Minor Changes
- 46f0f1700e: Extract a package for the Stack Overflow new backend system plugin.
Patch Changes
- Updated dependencies
- @backstage/plugin-search-backend-node@1.2.11
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-tasks@0.5.12
- @backstage/config@1.1.1
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-techdocs@1.9.0
Minor Changes
- 17f93d5589: A new analytics event
not-found
will be published when a user visits a documentation site that does not exist
Patch Changes
- 4728b3960d: Fixed navigation bug that caused users to not be scrolled to the top of a new page. Fixed navigation bug where using backwards and forwards browser navigation did not scroll users to the correct place on the TechDoc page.
- a3add7a682: Export alpha routes and nav item extension, only available for applications that uses the new Frontend system.
- 71c97e7d73: The `spec.lifecycle' field in entities will now always be rendered as a string.
- 68fc9dc60e: Updated alpha exports according to routing changes in
@backstage/frontend-plugin-api
. - 6c2b872153: Add official support for React 18.
- 0bf6ebda88: Added entity page content for the new plugin exported via
/alpha
. - 67cc85bb14: Switched the conditional
react-dom/client
import to useimport(...)
rather thanrequire(...)
. - 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - 38cda52746: Added support for React 18. The new
createRoot
API fromreact-dom/client
will now be used if present. - fdb5e23602: Import
MissingAnnotationEmptyState
from@backstage/plugin-catalog-react
to remove the cyclical dependency - Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/frontend-plugin-api@0.3.0
- @backstage/integration@1.7.2
- @backstage/integration-react@1.1.21
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-techdocs-react@1.1.13
- @backstage/plugin-search-react@1.7.2
- @backstage/theme@0.4.4
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-techdocs-backend@1.9.0
Minor Changes
- 67cff7b06f: Expose an extension point to set a custom build strategy. Also move
DocsBuildStrategy
type to@backstage/plugin-techdocs-node
and deprecateShouldBuildParameters
type.
Patch Changes
- c3c5c7e514: Add info about the entity when tech docs fail to build
- 48a61bfdca: Fix potential memory leak by not creating a build log transport if not given via
RouterOptions
. - 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - Updated dependencies
- @backstage/plugin-techdocs-node@1.10.0
- @backstage/integration@1.7.2
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/plugin-search-backend-module-techdocs@0.1.11
- @backstage/catalog-client@1.4.6
- @backstage/plugin-permission-common@0.7.10
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/plugin-catalog-common@1.0.18
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-techdocs-node@1.10.0
Minor Changes
- 67cff7b06f: Expose an extension point to set a custom build strategy. Also move
DocsBuildStrategy
type to@backstage/plugin-techdocs-node
and deprecateShouldBuildParameters
type.
Patch Changes
- e61a975f61: Switch to
@smithy/node-http-handler
instead of the@aws-sdk/node-http-handler
- 3d043526f4: Updated dependency
aws-sdk-client-mock
to^3.0.0
. - Updated dependencies
- @backstage/integration@1.7.2
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/integration-aws-node@0.1.8
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-vault-backend@0.4.0
Minor Changes
-
a873a32a1f: Added support for the new backend system.
In your
packages/backend/src/index.ts
make the following changes:import { createBackend } from '@backstage/backend-defaults';
const backend = createBackend();
// ... other feature additions
+ backend.add(import('@backstage/plugin-vault-backend');
backend.start();If you use the new backend system, the token renewal task can be defined via configuration file:
vault:
baseUrl: <BASE_URL>
token: <TOKEN>
schedule:
+ frequency: ...
+ timeout: ...
+ # Other schedule options, such as scope or initialDelayIf the
schedule
is omitted or set tofalse
no token renewal task will be scheduled. If the value ofschedule
is set totrue
the renew will be scheduled hourly (the default). In other cases (like in the diff above), the defined schedule will be used.DEPRECATIONS: The interface
VaultApi
and the typeVaultSecret
are now deprecated. Import them from@backstage/plugin-vault-node
.
Patch Changes
- Updated dependencies
- @backstage/plugin-vault-node@0.1.0
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-tasks@0.5.12
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
@backstage/plugin-vault-node@0.1.0
Minor Changes
- 7a41bcf2af: Initial version of the `plugin-vault-node`` package. It contains the extension point definitions for the vault backend, as well as some types that will be deprecated in the backend plugin.
Patch Changes
- Updated dependencies
- @backstage/backend-plugin-api@0.6.7
@backstage/app-defaults@1.4.5
Patch Changes
- 6c2b872153: Add official support for React 18.
- Updated dependencies
- @backstage/core-components@0.13.8
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-permission-react@0.4.17
- @backstage/core-app-api@1.11.1
- @backstage/theme@0.4.4
@backstage/backend-app-api@0.5.8
Patch Changes
- bc9a18d5ec: Added a workaround for double
default
wrapping when dynamically importing CommonJS modules with default exports. - Updated dependencies
- @backstage/config-loader@1.5.3
- @backstage/cli-node@0.2.0
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-tasks@0.5.12
- @backstage/cli-common@0.1.13
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-auth-node@0.4.1
- @backstage/plugin-permission-node@0.7.18
@backstage/backend-common@0.19.9
Patch Changes
- aa13482090: Limit the database creation concurrency to one, defensively
- 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - 3d043526f4: Updated dependency
aws-sdk-client-mock
to^3.0.0
. - Updated dependencies
- @backstage/config-loader@1.5.3
- @backstage/integration@1.7.2
- @backstage/backend-plugin-api@0.6.7
- @backstage/integration-aws-node@0.1.8
- @backstage/backend-app-api@0.5.8
- @backstage/backend-dev-utils@0.1.2
- @backstage/cli-common@0.1.13
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
@backstage/backend-defaults@0.2.7
Patch Changes
- Updated dependencies
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-app-api@0.5.8
@backstage/backend-plugin-api@0.6.7
Patch Changes
- 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - Updated dependencies
- @backstage/backend-tasks@0.5.12
- @backstage/plugin-permission-common@0.7.10
- @backstage/config@1.1.1
- @backstage/types@1.1.1
- @backstage/plugin-auth-node@0.4.1
@backstage/backend-tasks@0.5.12
Patch Changes
- 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - Updated dependencies
- @backstage/backend-common@0.19.9
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
@backstage/backend-test-utils@0.2.8
Patch Changes
- 013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support. - bb688f7b3b: Ensure recursive deletion of temporary directories in tests
- Updated dependencies
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/backend-app-api@0.5.8
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
- @backstage/plugin-auth-node@0.4.1
@backstage/catalog-client@1.4.6
Patch Changes
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - Updated dependencies
- @backstage/catalog-model@1.4.3
- @backstage/errors@1.2.3
@backstage/config-loader@1.5.3
Patch Changes
- 22ca64f117: Correctly resolve config targets into absolute paths
- 087bab5b42: Updated dependency
typescript-json-schema
to^0.62.0
. - Updated dependencies
- @backstage/cli-common@0.1.13
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/types@1.1.1
@backstage/core-app-api@1.11.1
Patch Changes
- 6c2b872153: Add official support for React 18.
- 89d13e5618: Add current and default scopes when refreshing session
- 9ab0572217: Add component data
core.type
marker forAppRouter
andFlatRoutes
. - Updated dependencies
- @backstage/core-plugin-api@1.8.0
- @backstage/version-bridge@1.0.7
- @backstage/config@1.1.1
- @backstage/types@1.1.1
@backstage/core-components@0.13.8
Patch Changes
-
81c8db2088: Fix
RoutedTabs
so that it does not explode without tabs. -
eb817ee6d4: Fix spacing inconsistency with links and labels in headers
-
f28c11743a: Add a possibility to use a formatter on a warning panel. Applied it for a scaffolder template
-
6c2b872153: Add official support for React 18.
-
e07570a740: Fixed an issue causing the
Select
component to show empty chips when some of the selected values did not match any item -
7bdc1b0a12: Fixed compatibility with Safari <16.3 by eliminating RegEx lookbehind in
extractInitials
.This PR also changed how initials are generated resulting in John Jonathan Doe => JD instead of JJ.
-
66071b42c0: Make the
options.titleFormat
prop of<StructuredMetadataTable />
apply to all keys including nested ones. Previously, this option would only apply to the root keys of themetadata
prop.Document and improve the props of
<StructuredMetadataTable />
. Previously, theoptions
prop wasany
. -
71c97e7d73: Fixed the type declaration of
DependencyGraphProps
, thedefs
prop now expectsJSX.Element
s. -
0c5b78650c: Reverting the
MissingAnnotationEmptyState
component due to cyclical dependency. This component is now deprecated, please use the import from@backstage/plugin-catalog-react
instead to use the new functionality -
4b7d341746: Updated dependency
linkify-react
to4.1.2
. -
0ef24425c1: Updated dependency
linkifyjs
to4.1.2
. -
4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. -
Updated dependencies
- @backstage/core-plugin-api@1.8.0
- @backstage/version-bridge@1.0.7
- @backstage/theme@0.4.4
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
@backstage/create-app@0.5.7
Patch Changes
-
770763487a: Cleaned up cases where deprecated code was being used but had a new location they should be imported from
-
013611b42e:
knex
has been bumped to major version 3 andbetter-sqlite3
to major version 9, which deprecate node 16 support.You can do the same in your own Backstage repository to ensure that you get future node 18+ relevant updates, by having the following lines in your
packages/backend/package.json
:"dependencies": {
// ...
"knex": "^3.0.0"
},
"devDependencies": {
// ...
"better-sqlite3": "^9.0.0", -
f577e1176f: Bumped create-app version.
-
6c2b872153: Add official support for React 18.
-
ae1602e54d: If create app installs dependencies, don't suggest to user that they also need to do it.
-
e6b7ab8d2b: Added missing node-gyp dependency to fix Docker image build
-
Updated dependencies
- @backstage/cli-common@0.1.13
@backstage/dev-utils@1.0.23
Patch Changes
- 67cc85bb14: Switched the conditional
react-dom/client
import to useimport(...)
rather thanrequire(...)
. - 38cda52746: Added support for React 18. The new
createRoot
API fromreact-dom/client
will now be used if present. - Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/integration-react@1.1.21
- @backstage/core-plugin-api@1.8.0
- @backstage/app-defaults@1.4.5
- @backstage/core-app-api@1.11.1
- @backstage/theme@0.4.4
- @backstage/catalog-model@1.4.3
@backstage/integration@1.7.2
Patch Changes
- 243c655a68: JSDoc and Error message updates to handle
Azure Active Directory
re-brand toEntra ID
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - Updated dependencies
- @backstage/config@1.1.1
@backstage/integration-aws-node@0.1.8
Patch Changes
- 20d97d28a3: Updated dependency
aws-sdk-client-mock-jest
to^3.0.0
. - 3d043526f4: Updated dependency
aws-sdk-client-mock
to^3.0.0
. - Updated dependencies
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
@backstage/integration-react@1.1.21
Patch Changes
- 6c2b872153: Add official support for React 18.
- Updated dependencies
- @backstage/integration@1.7.2
- @backstage/core-plugin-api@1.8.0
- @backstage/config@1.1.1
@backstage/release-manifests@0.0.11
Patch Changes
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
.
@backstage/test-utils@1.4.5
Patch Changes
- 6c2b872153: Add official support for React 18.
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - Updated dependencies
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-permission-react@0.4.17
- @backstage/core-app-api@1.11.1
- @backstage/theme@0.4.4
- @backstage/plugin-permission-common@0.7.10
- @backstage/config@1.1.1
- @backstage/types@1.1.1
@backstage/theme@0.4.4
Patch Changes
- 6c2b872153: Add official support for React 18.
@backstage/version-bridge@1.0.7
Patch Changes
- 6c2b872153: Add official support for React 18.
@backstage/plugin-adr@0.6.9
Patch Changes
- 6c2b872153: Add official support for React 18.
- 4aa43f62aa: Updated dependency
cross-fetch
to^4.0.0
. - fdb5e23602: Import
MissingAnnotationEmptyState
from@backstage/plugin-catalog-react
to remove the cyclical dependency - Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/frontend-plugin-api@0.3.0
- @backstage/integration-react@1.1.21
- @backstage/core-plugin-api@1.8.0
- @backstage/plugin-search-react@1.7.2
- @backstage/theme@0.4.4
- @backstage/catalog-model@1.4.3
- @backstage/plugin-adr-common@0.2.17
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-adr-backend@0.4.4
Patch Changes
- 68f8a55622: Updated dependency
@types/marked
to^5.0.0
. - Updated dependencies
- @backstage/integration@1.7.2
- @backstage/backend-common@0.19.9
- @backstage/backend-plugin-api@0.6.7
- @backstage/catalog-client@1.4.6
- @backstage/catalog-model@1.4.3
- @backstage/config@1.1.1
- @backstage/errors@1.2.3
- @backstage/plugin-adr-common@0.2.17
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-adr-common@0.2.17
Patch Changes
- Updated dependencies
- @backstage/integration@1.7.2
- @backstage/catalog-model@1.4.3
- @backstage/plugin-search-common@1.2.8
@backstage/plugin-airbrake@0.3.26
Patch Changes
- 6c2b872153: Add official support for React 18.
- fdb5e23602: Import
MissingAnnotationEmptyState
from@backstage/plugin-catalog-react
to remove the cyclical dependency - Updated dependencies
- @backstage/plugin-catalog-react@1.9.0
- @backstage/core-components@0.13.8
- @backstage/core-plugin-api@1.8.0
- @backstage/test-utils@1.4.5
- @backstage/theme@0.4.4
- @backstage/dev-utils@1.0.23
- @backstage/catalog-model@1.4.3