fix(deps): update backstage monorepo #21
Reference in New Issue
Block a user
Delete Branch "renovate/backstage-monorepo"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
1.0.10->1.5.7^0.22.0->^0.23.00.5.21->0.5.261.2.0->1.6.51.1.4->1.5.00.26.2->0.26.100.26.2->0.26.101.0.5->1.2.01.3.0->1.13.01.3.0->1.13.00.14.3->0.14.81.2.0->1.9.31.0.10->1.0.341.1.8->1.1.280.11.3->0.11.60.3.39->0.3.700.22.3->0.22.81.7.1->1.21.01.6.0->1.23.20.6.0->0.6.41.0.9->1.0.240.4.3->0.4.6^0.11.0->^0.12.01.2.3->1.12.10.6.14->0.6.160.6.23->0.6.260.7.13->0.7.140.7.27->0.7.320.4.8->0.4.23^0.4.0->^0.5.01.9.1->1.22.01.9.0->1.22.111.4.9->1.4.131.5.6->1.5.130.5.25->0.5.311.2.20->1.2.261.7.9->1.7.120.7.2->0.7.41.4.2->1.10.61.5.0->1.10.81.0.8->1.1.111.1.1->1.2.50.8.4->0.8.81.2.3->1.5.70.5.2->0.5.6Release Notes
backstage/backstage (@backstage/app-defaults)
v1.5.7Compare Source
Patch Changes
v1.5.6Compare Source
Patch Changes
v1.5.5Compare Source
Patch Changes
v1.5.4Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.v1.5.3Compare Source
Patch Changes
v1.5.2Compare Source
Patch Changes
v1.5.1Compare Source
Patch Changes
v1.5.0Compare Source
Minor Changes
f919be9: Added a utility API for VMware Cloud auth; the API ref is available in the@backstage/core-plugin-apiand@backstage/frontend-plugin-apipackages, theimplementation is in
@backstage/core-app-apiand a factory has been added to@backstage/app-defaults.7f11009: Added stack trace display toErrorPageand updated existing refsPatch Changes
f899eec: Change default icon forkind:resourceto the storage icon.9aac2b0: Use--cwdas the firstyarnargument7da67ce: ChangedefaultScopesfor Bitbucket auth from invalidteamtoaccount.214f2da: Fix invalid HTTP status code 501 in Error Pagev1.4.7Compare Source
Patch Changes
v1.4.6Compare Source
Patch Changes
v1.4.5Compare Source
Patch Changes
6c2b872: Add official support for React 18.v1.4.4Compare Source
Patch Changes
1a0616f: Add missing resource and template app icons9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.v1.4.3Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.4.2Compare Source
Patch Changes
v1.4.1Compare Source
Patch Changes
v1.4.0Compare Source
Minor Changes
1fd38bc: Material UI v5 Support: Adding platform-wide support for Material UI v5 allowing a transition phase for migrating central plugins & components over. We still support v4 instances & plugins by adding aTo allow the future support of plugins & components using Material UI v5 you want to upgrade your
AppTheme's to using theUnifiedThemeProviderPatch Changes
v1.3.1Compare Source
Patch Changes
575d917: Added a System Icon for resource entities.This can be obtained using:
Updated dependencies
v1.3.0Compare Source
Minor Changes
7908d72: Introduce a new global config parameter,enableExperimentalRedirectFlow. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.Patch Changes
v1.2.1Compare Source
Patch Changes
v1.2.0Compare Source
Minor Changes
db10b6e: Added a Bitbucket Server Auth Provider and added its API to the app defaultsPatch Changes
v1.1.0Compare Source
Minor Changes
bca8e8b: Allow defining application level feature flags. See Feature Flags documentation for reference.Patch Changes
backstage/backstage (@backstage/backend-common)
v0.23.2Compare Source
Patch Changes
8c09c97: Deprecate legacy status check factory, handler and types.d228862: Update default backend plugin created by the cli to use non-deprecated error handling middlewarec964a3d: Add dependencies that are needed by cross-imports from backend-defaultsb60db08: Fixing exporting of classes properly from new packagesv0.23.1Compare Source
v0.23.0Compare Source
Minor Changes
395b973: ImplementedreadTreefor Harness provider to support TechDocs functionality02103be: Deprecated and moved over core services to@backstage/backend-defaultsPatch Changes
9539a0b: Import utility functions frombackend-defaultsinstead ofbackend-app-apib2c4607: Removed accents on deprecation notec6c0919: Updated configuration schema to include theuseRedisSetscache config option.ed3074e: Thedatabasetypes, helpers and implementations were moved to the package@backstage/backend-defaultsand deprecated from the package@backstage/backend-commons.9cca724: TheTokenManagerhas been deprecated in preparation for the stable release of the New Backend System. Please migrate to the newcoreServices.auth,coreServices.httpAuth, andcoreServices.userInfoservices as needed instead.1779188: In preparation to the new backend system stable release, theisDatabaseConflictErrorhelper have been moved to the@backstage/backend-plugin-apipackage and deprecated from@backstage/backend-common.78a0b08: Internal refactor to handleBackendFeaturecontract change.e171620: Movecacheimplementation and types to the@backstage/backend-defaultspackage.1a6f38a:ContainerRunner,DockerContainerRunnerandKubernetesContainerRunnerare now deprecated8869b8e: We are deprecating the legacycreateServiceBuilderfactory, so if you are still using it, please checkout the migration guide and migrate your plugin to use the new backend system.0634fdc: DeprecateddropDatabaseb2ee7f3: Moved over all URL reader functionality from@backstage/backend-commonto@backstage/backend-defaults/urlReader. Please update your imports.d94a477: Removed the circular dependency on@backstage/backend-app-api3bd04bb: We are deprecating the legacy router handlers and contexts in preparation for the new backend system stable release.23ee9ab: Fix AWS CodeCommit integration by allowing to change the hoste9a03c9: Finalizes the deprecation of legacy backend utilities. Deprecated utilities include theServiceBuildertype,notFoundHandlerandredactWintonLogLinefunctions.6a576dc: Deprecate legacy service logger helpers and stop usinggetVoidLoggerin tests.032a7a6: Deprecate the legacy error and request logging handler types, respectively:ErrorHandlerOptionsandRequestLoggingHandlerFactory.backstage/backstage (@backstage/backend-tasks)
v0.5.26Compare Source
Patch Changes
083eaf9: Fix bug where ISO durations could no longer be used for schedulesv0.5.25Compare Source
v0.5.24Compare Source
Patch Changes
736bc3c: Marked all exports as deprecated and pointed at@backstage/backend-plugin-apiand@backstage/backend-defaultsed473cd: Updated theTaskScheduleDefinitionConfigdeprecated comment to point toSchedulerServiceTaskScheduleDefinitionConfig6a576dc: Deprecate the legacyTaskScheduler.fromConfigmethod and stop using thegetVoidloggerin tests files to reduce the dependency on the soon-to-deprecatebackstage-commonpackage.1897169: More detailed deprecation messagesv0.5.23Compare Source
Patch Changes
d229dc4: Move path utilities frombackend-commonto thebackend-plugin-apipackage.v0.5.22Compare Source
Patch Changes
d5a1fe1: Replaced winston logger withLoggerServicebackstage/backstage (@backstage/catalog-client)
v1.6.5Compare Source
Patch Changes
v1.6.4Compare Source
Patch Changes
dad7505: Fix theCatalogClient::getEntitiesmethod to only sort the resulting entities in case noorder-parameter is provided.v1.6.3Compare Source
Patch Changes
7e8a7c8: Added missing commas to the example ofqueryEntitiesv1.6.2Compare Source
Patch Changes
7e8a7c8: Added missing commas to the example ofqueryEntitiesv1.6.1Compare Source
Patch Changes
6f830bb: Allow passing optional filter togetEntitiesByRefsv1.6.0Compare Source
Minor Changes
43dad25: Add API to get location by entity04907c3: Updates the OpenAPI specification title to plugin ID instead of package name.Patch Changes
c04c42b: Internal updates to auto-generated files.v1.5.2Compare Source
Patch Changes
883782e: Fix a bug ingetLocationByRefthat led to invalid backend callsv1.5.1Compare Source
Release v1.5.1
@backstage/plugin-scaffolder-backend@1.5.1
Patch Changes
vm2. This is to mitigate a sandbox escape recently discovered in thevm2library which provides the sandbox for the scaffolder and the templating functionality. Please make sure that thevm2version in your Backstage instance is at least 3.9.11.v1.5.0Compare Source
Minor Changes
3834067: The internals ofCatalogClientare now auto-generated using thebackstage-repo-tools schema openapi generate-clientcommand.Patch Changes
82fa88b: Fixes a bug where some query parameters were double URL encoded.v1.4.6Compare Source
Patch Changes
4aa43f6: Updated dependencycross-fetchto^4.0.0.v1.4.5Compare Source
Patch Changes
v1.4.4Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v1.4.3Compare Source
Patch Changes
v1.4.2Compare Source
Patch Changes
cc936b5: Updated API docsv1.4.1Compare Source
Patch Changes
c1c4e08: Fixed bug inqueryEntitiesofCatalogClientwhere thesortFieldis supposed to be changed toorderField.v1.4.0Compare Source
Minor Changes
8c030b1: AddqueryEntitiesmethod toCatalogApi.Patch Changes
52b0022: Updated dependencymswto^1.0.0.c630360: Ensure thatgetEntitiesByRefsreturnsundefinedinstead ofnullfor missing itemsv1.3.1Compare Source
Patch Changes
v1.3.0Compare Source
Minor Changes
f75bf76: Implemented support for theorderdirective ongetEntitiesPatch Changes
e23f13a: Enable theby-refsendpoint to receivefieldsthrough the POST body as well as through query parameters.backstage/backstage (@backstage/catalog-model)
v1.5.0Compare Source
Minor Changes
79025f3: Introduce a domain attribute to the domain entity to allow a hierarchy of domains to exist.v1.4.5Compare Source
Patch Changes
v1.4.4Compare Source
Patch Changes
07e7d12: Fix wording in API referencev1.4.3Compare Source
Patch Changes
0b55f77: Removed some unused dependenciesv1.4.2Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v1.4.1Compare Source
Patch Changes
v1.4.0Compare Source
Minor Changes
33eae4b: Deprecate target field and make targetRef required in common.schema.jsonPatch Changes
af748a1: Add OpenAPI Specification (OAS) v3.1.0 examples.1df5fc9: Remove requirement for 'target' property of EntityRelationv1.3.0Compare Source
Minor Changes
be9c422: Modified the regex for DNS label validation to support IDN domainsPatch Changes
v1.2.1Compare Source
Patch Changes
928a12a: Internal refactor of/alphaexports.v1.2.0Compare Source
Minor Changes
d516688: Adds the tRPC API type to the catalog.Patch Changes
aece6c5: Add additional validation for location references.2518ef5: Add deprecation tag to kubernetes constants in catalog, constants are now defined in plugin-kubernetes-commonv1.1.5Compare Source
Patch Changes
011bd51: Fixed spelling mistakes in documentation.backstage/backstage (@backstage/cli)
v0.26.10Compare Source
Patch Changes
e2e320c: - remove unused dependencieswinstonandynfrom the template of backend plugins;mswto version2.3.1in the template of backend plugins;starting with v1 and switching later to v2 is tedious and not straight forward; it's easier to start with v2;
0540c5a: Updated the scaffolding output message forplugin-commoninbackstage-cli. Now, when executingbackstage-cli newto create a newplugin-commonpackage, the output message accurately reflects the action by displayingCreating common plugin package...instead of the previous, less accurateCreating backend plugin....7652db4: Only bootstrap global-agent if it's actually being usedf0c0039: Fix issue with CLI that was preventing upgrading from 1.28d228862: Update default backend plugin created by the cli to use non-deprecated error handling middlewareda90cce: Updated dependencyesbuildto^0.21.0.a60d73b: Fix a few minor issues with the backend template that were causing failing linting checks in the main repo.0510d98: Subpath exportpackage.jsonshould be of a unique name to avoid typescript resolution issuesv0.26.9Compare Source
v0.26.8Compare Source
v0.26.7Compare Source
Patch Changes
788eca7: Fix readme for new plugins created using cli90c5268: AddpeerDependenciestodevDependenciesinpackage.json.hbstemplates.c00f7ee: Fix issue withesmloaded dependencies being different from thecjsimport for Vite dependenciesb0f66e9: Updated dependencyvite-plugin-node-polyfillsto^0.22.0.c328131: Added a new--publishflag to therepo fixcommand. This command will validate and if possible generate the metadata required for publishing packages with the Backstage CLI. In addition, a check has been added that thebackstage.pluginIdandbackstage.pluginPackage(s)fields are present when packing a package for publishing.5afbe1d: Export default module forscaffolder-actioncli template009da47: Fixversions:check --fixwhenyarn.lockhas multiple joint versions in the same section9ee948a: Bumpesbuildtarget for package builds toES2022.v0.26.6Compare Source
Patch Changes
009da47: Fixversions:check --fixwhenyarn.lockhas multiple joint versions in the same section9ee948a: Bumpesbuildtarget for package builds toES2022.v0.26.5Compare Source
Patch Changes
b8f1fc2: Thebuild-workspacecommand no longer manually runsyarn postpack, relying instead on the fact that runningyarn packwill automatically invoke thepostpackscript. No action is necessary if you are running the latest version of yarn 1, 3, or 4.fcd3462: Both the target and types library have been bumped from ES2021 to ES2022 in@backstage/cli/config/tsconfig.json.0cc5ed3: Add support forversions:migrateto do code changes. Can be skipped with--no-code-changesf97ad04: Add preserveModules to rollup, which allows better async loading and tree-shaking in webpack2a6f10d: Theversions:bumpcommand will no longer exit with a non-zero status if the version bump fails due to forbidden duplicate package installations. It will now also provide more information about how to troubleshoot such an error. The set of forbidden duplicates has also been expanded to include all@backstage/*-app-apipackages.c5d7b40: Allow passing a--requireargument through to the Node process duringpackage startcc3c518: Fixed an issue causing therepo fixcommand to set an incorrectworkspaceproperty using Windows812dff0: Add previously-missing semicolon in file templated bybackstage-cli new --select plugin.f185603: Fixed the dynamic import of vite.v0.26.4Compare Source
v0.26.3Compare Source
Patch Changes
c884b9a: Fix the bundle public subpath configuration.e3c213e: Add the deprecation plugin to the default linter setup, switched off.This allows to disable deprecation warnings for
backstage-cli repo list-deprecationswith inline comments.4946f03: Updated dependencywebpack-dev-serverto^5.0.0.6b5ddbe: Fix the backend plugin to use correct plugin id4fecffc: When building the frontend app public assets are now also copied to the public dist directory when in use.ed9260f: Addedversions:migratecommand to help move packages to the new@backstage-communitynamespaceUpdated dependencies
backstage/backstage (@backstage/config)
v1.2.0Compare Source
Minor Changes
50cf9df: TheConfigReadernow treatsnullvalues as present but explicitly undefined, meaning it will not fall back to the next level of configuration.Patch Changes
v1.1.1Compare Source
Patch Changes
v1.1.0Compare Source
Minor Changes
62f448e: Added areadDurationFromConfigfunctionPatch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.0.8Compare Source
Patch Changes
v1.0.7Compare Source
Patch Changes
482dae5: Updated link to docs.v1.0.6Compare Source
Patch Changes
ba2d69e: Adds the ability to coerce values to their boolean representatives.Values such as
"true"1onandywill becometruewhen usinggetBooleanand the oppositesfalse.This happens particularly when such parameters are used with environmental substitution as environment variables are always strings.
backstage/backstage (@backstage/core-app-api)
v1.13.0Compare Source
Minor Changes
d3c39fc: Allow for the disabling of external routes through config, which was rendered impossible after the introduction of default targets.This has the effect of removing the button for registering new
catalog entities in the scaffolder template list view
v1.12.6Compare Source
Patch Changes
35fbe09: Added support for configuration of route bindings through static configuration, and default targets for external route refs.In addition to configuring route bindings through code, it is now also possible to configure route bindings under the
app.routes.bindingskey, for example:Each key in the route binding object is of the form
<plugin-id>.<externalRouteName>, where the route name is key used in theexternalRoutesobject passed tocreatePlugin. The value is of the same form, but with the name taken from the pluginroutesoption instead.The equivalent of the above configuration in code is the following:
Updated dependencies
v1.12.5Compare Source
Patch Changes
1bed9a3: The Backstage identity session expiration check will no longer fall back to using the provider expiration. This was introduced to smooth out the rollout of Backstage release 1.18, and is no longer needed.v1.12.4Compare Source
Patch Changes
c884b9a: The app is now aware of if it is being served from theapp-backendwith a separate public and protected bundles. When in protected mode the app will now continuously refresh the session cookie, as well as clear the cookie if the user signs out.abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.v1.12.3Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.12.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.12.1Compare Source
Patch Changes
v1.12.0Compare Source
Minor Changes
f919be9: Added a utility API for VMware Cloud auth; the API ref is available in the@backstage/core-plugin-apiand@backstage/frontend-plugin-apipackages, theimplementation is in
@backstage/core-app-apiand a factory has been added to@backstage/app-defaults.Patch Changes
9aac2b0: Use--cwdas the firstyarnargument8fe56a8: Widen@types/reactdependency range to include version 18.7da67ce: ChangedefaultScopesfor Bitbucket auth from invalidteamtoaccount.v1.11.3Compare Source
Patch Changes
v1.11.2Compare Source
Patch Changes
3e358b0: Added deprecation warning for React Router v6 beta, please make sure you have migrated your apps to use React Router v6 stable as support for the beta version will be removed. See the migration tutorial for more information.0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v1.11.1Compare Source
Patch Changes
6c2b872: Add official support for React 18.89d13e5: Add current and default scopes when refreshing session9ab0572: Add component datacore.typemarker forAppRouterandFlatRoutes.v1.11.0Compare Source
Minor Changes
c9d9bfe: URL encode some well known unsafe characters inRouteResolver(and thereforeuseRouteRef)Patch Changes
29e4d8b: Fixed bug inAppRouterto determine the correctsignOutTargetUrlifapp.baseUrlcontains abasePathacca17e: Wrap entire app in<Suspense>, enabling support for using translations outside plugins.1a0616f: Add missing resource and template app icons9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.f1b349c: Fixed a bug inTranslationApiimplementation where in some cases it wouldn't notify subscribers of language changes.v1.10.0Compare Source
Minor Changes
18619f7: Fixed two bugs in how theOAuth2Sessiontype represents the underlying data. TheexpiresAtandbackstageIdentityare now both optional, since that's what they are in practice. This is not considered a breaking change since it was effectively a bug in the modelling of the state that this type represents, and the type was not used in any other external contract.18619f7: TheOAuthclass which is used by all OAuth providers will now consider both the session expiration of both the Backstage identity as well as the upstream identity provider, and refresh the session with either of them is about to expire.6e30769: Introduced experimental support for internationalization.Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.9fe827b: Internal refactor8cec766: Removed@types/nodedependencyv1.9.1Compare Source
Patch Changes
9ae4e7e: Fixed a bug that could causenavigateanalytics events to be misattributed to the plugin mounted on the root route (e.g. thehomeplugin at/) when the route that was navigated to wasn't associated with a routable extension.v1.9.0Compare Source
Minor Changes
a77ddf7: add login in popup options to config popup width and heightPatch Changes
8174cf4: Fixing MUI / Material UI referencesv1.8.1Compare Source
Patch Changes
12adfbc: Fixed a bug that prevented accurate plugin and route data from being applied tonavigateanalytics events when users visited pages constructed with<EntityLayout>,<TabbedLayout>, and similar components that are used to gather one or more routable extensions under a given path.ac677bc: Expose discovery.endpoints configuration to use FrontendHostDiscovery74b216e: AddPropsWithChildrento usages ofComponentType, in preparation for React 18 where the children are no longer implicit.v1.8.0Compare Source
Minor Changes
c89437d: The analytics'navigateevent will now include the route parameters as attributes of the navigate eventPatch Changes
b645d70: Fixed a bug in the Azure auth provider which prevented getting access tokens with multiple scopes for one resource42d817e: AddedFrontendHostDiscoveryfor config driven discovery implementationv1.7.0Compare Source
Minor Changes
7908d72: Introduce a new global config parameter,enableExperimentalRedirectFlow. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.c15e0ce: TheAuthConnectorinterface now supports specifying a set of scopes whenrefreshing a session. The
DefaultAuthConnectorimplementation passes thescopequery parameter to the auth-backend plugin appropriately. TheRefreshingAuthSessionManagerpasses any scopes in itsGetSessionRequestappropriately.
Patch Changes
1e4f5e9: Bumpzodandzod-to-json-schemadependencies.e0c6e8b: Update peer dependenciesv1.6.0Compare Source
Minor Changes
456eaa8:OAuth2now gets ID tokens from a session with theopenidscope explicitlyrequested.
This should not be considered a breaking change, because spec-compliant OIDC
providers will already be returning ID tokens if and only if the
openidscopeis granted.
This change makes the dependence explicit, and removes the burden on
OAuth2-based providers which require an ID token (e.g. this is done by various
default auth handlers) to add
openidto their default scopes. That could carry another indirect benefit:by removing
openidfrom the default scopes for a provider, grants forresource-specific access tokens can avoid requesting excess ID token-related
scopes.
Patch Changes
52b0022: Updated dependencymswto^1.0.0.v1.5.0Compare Source
Minor Changes
db10b6e: Added a Bitbucket Server Auth Provider and added its API to the app defaultsPatch Changes
dff4d8d: Fixed an issue where an explicit port the frontend base URL could break the app.v1.4.0Compare Source
Minor Changes
bca8e8b: Allow defining application level feature flags. See Feature Flags documentation for reference.Patch Changes
backstage/backstage (@backstage/core-components)
v0.14.8Compare Source
Patch Changes
a0b46f6: Having tooltip inherit font size for consistency in catalog table columns59cee81: Useinheritvariant on OverflowTooltip underlying Typography component.eae0e4d: Fixed an issue causingSidebarSubmenutext to not follow the theme colore4811ec: Make number of decimal digits in Gauge configurable via thedecimalDigitsproperty83c4251: Adds icons to status component3e175c8: Removed max width fromSelectcomponent.57d7582: Fixed a bug inSupportButtonwhere the title was rendered with the characteristics of a button.v0.14.7Compare Source
Patch Changes
e42779e: Properly log theerrorInfoinErrorBoundary5223c4c: Fixed an internal circular import that broke Jest mocks.71e4229: Added optionalinitialShowDropDownprop toSidebarSubmenuItemto internally manage the initial display state of the dropdown items.a2ee4df: AddalignGaugeprop to theGaugeCard, and a small size version. WhenalignGaugeis'bottom'the gauge will vertically align the gauge in the cards, even when the card titles span across multiple lines.Add
alignContentprop to theInfoCard, defaulting to'normal'with the option of'bottom'which vertically aligns the content to the bottom of the card.5b7b49b: TheSignInPageguest provider will now fall back to legacy guest auth if the backend request fails, allowing guest auth without a running backend.359376a: Removing react-text-truncate with css styles.v0.14.6Compare Source
Patch Changes
5223c4c: Fixed an internal circular import that broke Jest mocks.5b7b49b: TheSignInPageguest provider will now fall back to legacy guest auth if the backend request fails, allowing guest auth without a running backend.v0.14.5Compare Source
Patch Changes
71e4229: Added optionalinitialShowDropDownprop toSidebarSubmenuItemto internally manage the initial display state of the dropdown items.v0.14.4Compare Source
Patch Changes
ed5c901: Noundefinedclass name used atMarkdownContentif no custom class name was provided.abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.f546e38: Added Link component inTabUIproviding functionality like copy link or open in new tab.backstage/backstage (@backstage/core-plugin-api)
v1.9.3Compare Source
Patch Changes
35fbe09: A newdefaultTargetoption has been added tocreateExternalRouteRef. This allows one to specify a default target of the route by name, for example'catalog.catalogIndex', which will be used if the target route is present in the app and there is no explicit route binding.v1.9.2Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.v1.9.1Compare Source
Patch Changes
v1.9.0Compare Source
Minor Changes
f919be9: Added a utility API for VMware Cloud auth; the API ref is available in the@backstage/core-plugin-apiand@backstage/frontend-plugin-apipackages, theimplementation is in
@backstage/core-app-apiand a factory has been added to@backstage/app-defaults.Patch Changes
8fe56a8: Widen@types/reactdependency range to include version 18.e586f79: Throw a more specific exceptionNotImplementedErrorwhen an API implementation cannot be found.v1.8.2Compare Source
Patch Changes
6878b1d: Removed unnecessaryi18nextdependency.v1.8.1Compare Source
Patch Changes
03d0b6d: Removed the alphaconvertLegacyRouteRefutility, which as been moved to@backstage/core-compat-api0c93dc3: ThecreateTranslationReffunction from the/alphasubpath can now also accept a nested object structure of default translation messages, which will be flatted using.separators.v1.8.0Compare Source
Minor Changes
1e5b7d9:IconComponentcan now have afontSizeofinherit, which is useful for in-line icons.cb6db75: IntroducedAnyRouteRefParamsas a replacement forAnyParams, which is now deprecated.Patch Changes
6c2b872: Add official support for React 18.cb6db75: 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.68fc9dc: Added a new/alphaexportconvertLegacyRouteRef, which is a temporary utility to allow existing route refs to be used with the new experimental packages.v1.7.0Compare Source
Minor Changes
322bbca: Removed the exprimental plugin configuration API. The__experimentalReconfigure()from the plugin options as well as the__experimentalConfigure()method on plugin instances have both been removed.Patch Changes
0b55f77: Removed some unused dependencies9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.v1.6.0Compare Source
Minor Changes
18619f7: Added the optionalexpiresAtfield that may now be part of aBackstageIdentityResponse.6e30769: Introduced experimental support for internationalization.Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.5.3Compare Source
Patch Changes
8174cf4: Fixing MUI / Material UI references13426eb: ChangeIconComponenttype to be compatible with Material UI v5 icons.v1.5.2Compare Source
Patch Changes
12adfbc: Fixed a bug that prevented accurate plugin and route data from being applied tonavigateanalytics events when users visited pages constructed with<EntityLayout>,<TabbedLayout>, and similar components that are used to gather one or more routable extensions under a given path.74b216e: AddPropsWithChildrento usages ofComponentType, in preparation for React 18 where the children are no longer implicit.v1.5.1Compare Source
Patch Changes
760f521: Add component name as data attribute for all components2898b6c: Minor type tweaks for TypeScript 5.0e0c6e8b: Update peer dependenciesv1.5.0Compare Source
Minor Changes
ab750dd: The GitLab auth provider can now be used to get OpenID tokens.Patch Changes
928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.v1.4.0Compare Source
Minor Changes
db10b6e: Added a Bitbucket Server Auth Provider and added its API to the app defaultsPatch Changes
v1.3.0Compare Source
Minor Changes
bca8e8b: Allow defining application level feature flags. See Feature Flags documentation for reference.Patch Changes
backstage/backstage (@backstage/dev-utils)
v1.0.34Compare Source
Patch Changes
v1.0.33Compare Source
Patch Changes
v1.0.32Compare Source
Patch Changes
v1.0.31Compare Source
Patch Changes
9a41a7b: Allow defining custom sidebar item for page and login for the development appabfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.995f66b: add @backstage/no-top-level-material-ui-4-imports lint rulev1.0.30Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.0.29Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.0.28Compare Source
Patch Changes
v1.0.27Compare Source
Patch Changes
8fe56a8: Widen@types/reactdependency range to include version 18.v1.0.26Compare Source
Patch Changes
v1.0.25Compare Source
Patch Changes
v1.0.24Compare Source
v1.0.23Compare Source
Patch Changes
67cc85b: Switched the conditionalreact-dom/clientimport to useimport(...)rather thanrequire(...).38cda52: Added support for React 18. The newcreateRootAPI fromreact-dom/clientwill now be used if present.v1.0.22Compare Source
Patch Changes
080d1be: Moving developmentdependenciestodevDependencies9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.9468a67: Added support for React 18. The newcreateRootAPI fromreact-dom/clientwill now be used if present.v1.0.21Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.0.20Compare Source
Patch Changes
v1.0.19Compare Source
v1.0.18Compare Source
Patch Changes
254ad46: Removed deprecated calls toapp.getProvider()andapp.getRouter()inDevAppBuilderv1.0.17Compare Source
Patch Changes
v1.0.16Compare Source
Patch Changes
74b216e: AddPropsWithChildrento usages ofComponentType, in preparation for React 18 where the children are no longer implicit.v1.0.15Compare Source
Patch Changes
v1.0.14Compare Source
Patch Changes
e0c6e8b: Update peer dependenciesv1.0.13Compare Source
Patch Changes
482dae5: Updated link to docs.v1.0.12Compare Source
Patch Changes
v1.0.11Compare Source
Patch Changes
backstage/backstage (@backstage/integration-react)
v1.1.28Compare Source
Patch Changes
23ee9ab: Fix AWS CodeCommit integration by allowing to change the hostv1.1.27Compare Source
Patch Changes
v1.1.26Compare Source
Patch Changes
cb1e3b0: Updated dependency@testing-library/domto^10.0.0.v1.1.25Compare Source
Patch Changes
b38dc55: UpdatedmicrosoftAuthApiscopes for Azure DevOps to be fully qualified.v1.1.24Compare Source
Patch Changes
v1.1.23Compare Source
Patch Changes
v1.1.22Compare Source
Patch Changes
v1.1.21Compare Source
Patch Changes
6c2b872: Add official support for React 18.v1.1.20Compare Source
Patch Changes
0b55f77: Removed some unused dependencies9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.v1.1.19Compare Source
Patch Changes
482bb5c: Moved@types/reactto be a regular dependency406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.1.18Compare Source
Patch Changes
482bb5c: Moved@types/reactto be a regular dependencyv1.1.17Compare Source
v1.1.16Compare Source
Patch Changes
12a8c94: Add package repository and homepage metadatav1.1.15Compare Source
Patch Changes
v1.1.14Compare Source
Patch Changes
v1.1.13Compare Source
Patch Changes
v1.1.12Compare Source
Patch Changes
29ba826: Updated dependency@material-ui/labto4.0.0-alpha.61.e0c6e8b: Update peer dependenciesv1.1.11Compare Source
Patch Changes
52b0022: Updated dependencymswto^1.0.0.v1.1.10Compare Source
Patch Changes
v1.1.9Compare Source
Patch Changes
backstage/backstage (@backstage/plugin-api-docs)
v0.11.6Compare Source
Patch Changes
7f84039: TheregisterComponentexternal route will now by default bind to the catalog import page if it is available.9cdc651: Make sure that the toggle button state is properly reflected in API cardsd44a20a: Added additional plugin metadata topackage.json.96cd13e:DefaultApiExplorerPagenow accepts an optionalownerPickerModefor toggling the behavior of theEntityOwnerPicker, exposing a new mode<DefaultApiExplorerPage ownerPickerMode="all" />particularly suitable for larger catalogs. In this new mode,EntityOwnerPickerwill display all the users and groups present in the catalog.v0.11.5Compare Source
Patch Changes
5d99272: Update local development dependencies.725ff0b: Fix dark mode text color inside tables indescription:from OpenAPI definitionsv0.11.4Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.backstage/backstage (@backstage/plugin-app-backend)
v0.3.70Compare Source
Patch Changes
v0.3.69Compare Source
v0.3.68Compare Source
Patch Changes
8869b8e: Updated local development setup.78a0b08: Internal refactor to handleBackendFeaturecontract change.82c2b90: Restore the support of external config schema in the router of theapp-backendplugin, which was broken in release1.26.0.This support is critical for dynamic frontend plugins to have access to their config values.
d44a20a: Added additional plugin metadata topackage.json.v0.3.67Compare Source
v0.3.66Compare Source
Patch Changes
d229dc4: Move path utilities frombackend-commonto thebackend-plugin-apipackage.v0.3.65Compare Source
Patch Changes
d5a1fe1: Replaced winston logger withLoggerServicec884b9a: Track assets namespace in the cache store, implement a cookie authentication for when the public entry is enabled and used with the new auth services.v0.3.64Compare Source
Patch Changes
v0.3.63Compare Source
Patch Changes
v0.3.62Compare Source
Patch Changes
52e43f2: Disable default auth policy, allowing unauthenticated access to app bundle.v0.3.61Compare Source
Patch Changes
v0.3.60Compare Source
v0.3.59Compare Source
v0.3.58Compare Source
Patch Changes
9aac2b0: Use--cwdas the firstyarnargument998ccf6: Support injecting config multiple times in a single bundle6bb6f3e: Updated dependencyfs-extrato^11.2.0.Updated dependency
@types/fs-extrato^11.0.0.54ad8e1: Allow theapp-backendplugin to use a global configuration schema provided externally through an extension.9dfd57d: Do not force caching of the Javascript asset that contains the injected config.v0.3.57Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv0.3.56Compare Source
Patch Changes
v0.3.55Compare Source
Patch Changes
013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.v0.3.54Compare Source
Patch Changes
v0.3.53Compare Source
Patch Changes
v0.3.52Compare Source
v0.3.51Compare Source
Patch Changes
71114ac: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
cfc3ca6: Changes needed to support MySQLUpdated dependencies
v0.3.50Compare Source
Patch Changes
cfc3ca6: Changes needed to support MySQLv0.3.49Compare Source
v0.3.48Compare Source
Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.configd564ad1: Migrated the alphaappBackendexport to use static configuration and extension points rather than accepting options.v0.3.47Compare Source
Patch Changes
v0.3.46Compare Source
Patch Changes
v0.3.45Compare Source
Patch Changes
v0.3.44Compare Source
Patch Changes
v0.3.43Compare Source
Patch Changes
928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.v0.3.42Compare Source
Patch Changes
0ff0331: Updated usage ofcreateBackendPlugin.v0.3.41Compare Source
v0.3.40Compare Source
Patch Changes
b4ffa3b: The warning for missing app contents is now logged as an error instead, but only in production.ecbec4e: Internal refactor to match new options pattern in the experimental backend system.8e06f3c: Switched imports ofloggerToWinstonLoggerto@backstage/backend-common.backstage/backstage (@backstage/plugin-auth-backend)
v0.22.8Compare Source
Patch Changes
v0.22.7Compare Source
v0.22.6Compare Source
Patch Changes
3e823d3: Limited user tokens will no longer include theentfield in its payload. Ownership claims will now be fetched from the user info service.NOTE: Limited tokens issued prior to this change will no longer be valid. Users may have to clear their browser cookies in order to refresh their auth tokens.
8869b8e: Updated local development setup.78a0b08: Internal refactor to handleBackendFeaturecontract change.d44a20a: Added additional plugin metadata topackage.json.3e1bb15: Updated to use the new@backstage/plugin-auth-backend-module-onelogin-providerimplementationUpdated dependencies
v0.22.5Compare Source
Patch Changes
d229dc4: Move path utilities frombackend-commonto thebackend-plugin-apipackage.4a0577e: fix: Move config declarations to appropriate auth backend modulesea9262b: Allow overriding default ownership resolving with the newAuthOwnershipResolutionExtensionPointv0.22.4Compare Source
Patch Changes
f02fe79: Refactored theazure-easyauthprovider to use the implementation from@backstage/plugin-auth-backend-module-azure-easyauth-provider.d62bc51: Added token type header parameter and user identity proof to issued user tokens.ba763b6: Migrate the Bitbucket auth provider to the new@backstage/plugin-auth-backend-module-bitbucket-providermodule package.bf4d71a: Initial implementation of the/v1/userinfoendpoint, which is now able to parse and return thesubandentclaims from a Backstage user token.c26218d: Deprecated some of the Cloudflare Access types and used the implementation from@backstage/plugin-auth-backend-module-cloudflare-access-providerbackstage/backstage (@backstage/plugin-catalog)
v1.21.0Compare Source
Minor Changes
863a800: Added the following default targets for external routes:createComponentbinds to the Scaffolder page.viewTechDocbinds to the TechDocs entity documentation page.createFromTemplatebinds to the Scaffolder selected template page.Patch Changes
d44a20a: Added additional plugin metadata topackage.json.e04e57d: Fix bug with missing Actions column after adding "pagination" prop to catalog tablea2d2649: ExportcatalogTranslationRefunder/alphabcec60f: updated the ContextMenu, ActionsPage, OngoingTask and TemplateCard frontend components to support the new scaffolder permissions:scaffolder.task.createscaffolder.task.cancelscaffolder.task.readUpdated dependencies
v1.20.0Compare Source
Minor Changes
8834daf: Updated the presentation API to return a promise, in addition to the snapshot and observable that were there before. This makes it much easier to consume the API in a non-React context.Patch Changes
131e5cb: Fix broken links in README.5d99272: Update local development dependencies.4118530: Avoiding pre-loading display total count undefined for table countsv1.19.0Compare Source
Minor Changes
18c7f12: AddisApiType()to EntitySwitch routing functions.Patch Changes
bcb2674: Added a "create something similar" button to the<AboutCard>that is visible and links to the scaffolder template corresponding to the entity'sbackstage.io/source-templateannotation, if present.4ef0dcf: Fixed a bug that prevented the defaultentityPresentationApifrom being set in apps using the new frontend system.abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.7495b36: Fixed sorting of columns created withCatalogTable.columns.createLabelColumn.v1.18.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use librarybbbd510:CatalogIndexPagenow usesEntitySearchBarfor text-based filtering of entities, saving the search text in the query parameters and debouncing the server requests.v1.18.1Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.18.0Compare Source
Minor Changes
72b8827: Adds a title to thePaginatedCatalogTablefor better visibility on what you're viewing.Patch Changes
50b6687: Resolved an issue where thePaginatedCatalogTablewas not propagating table options to its child table.9332425: The entity page extension provided by the/alphaplugin now correctly renders the entity 404 page.1c0b179: Added theno-top-level-material-ui-4-importsESLint rule to aid with the migration to Material UI v52ac1630: Added support for passing in custom filters toCatalogIndexPage298953b: Added support for providing aninitiallySelectedNamespaceswhich accepts an array of Namespaces to have selected by default6727665: Allow thespec.targetfield to be searchable in the catalog table for locations. Previously, only thespec.targetsfield was be searchable. This makes locations generated by providers such as theGithubEntityProvidersearchable in the catalog table. #23098v1.17.0Compare Source
Minor Changes
d208a93: Updated the paginated catalog table to support server side text filtering.1f8c2fa: Add entity warning components to the default entity overview page.e541c0e: ExportedCatalogTable.defaultColumnsFuncfor defining the columns in<CatalogTable />of some Kinds while using the default columns for the others.Patch Changes
916da47: Change default icon for unknown entities to nothing instead of the help icon.f899eec: Change default icon forkind:resourceto the storage icon.9aac2b0: Use--cwdas the firstyarnargument912ca7b: UseconvertLegacyRouteRefsto define routes in/alphaexport plugin.797a329: Fixed inconsistencies in icons used for System and Template8fe56a8: Widen@types/reactdependency range to include version 18.987f565: Add line clamping toCatalogSearchResultListItem172a717: Fix entity content extension filtering.v1.16.1Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.16.0Compare Source
Minor Changes
e223f22: Properly support both function- and string-form visibility filter expressions in the new extensions exported via/alpha.b8e1eb2: Thecolumnsprop can be an array or a function that returns an array in order to override the default columns of theCatalogIndexPage.Patch Changes
bc7e6d3: Fix copy entity url function in http contexts.5360097: Ensure that passed-in icons are taken advantage of in the presentation API4785d05: Add permission check to catalog create and refresh buttoncd910c4: - Fixes bug where after unregistering an entity you are redirected to/.unregisterRedirectto override this behaviour to another route.03d0b6d: TheconvertLegacyRouteRefutility used by the alpha exports is now imported from@backstage/core-compat-api.2d708d8: Internal naming updates for/alphaexports.a5a0473: Internal refactor of alpha exports due to a change in how extension factories are defined.4d9e3b3: Register component overrides in the globalOverrideComponentNameToClassKeysprovided by@backstage/theme. This will in turn will provide component style override types forcreateUnifiedTheme.a1227cc: Wrap/alphaexport extension elements in backwards compatibility wrapper.78a10bb: Adding in spec.type chip to search results for clarity8f5d6c1: Updates to the/alphaexports to match the extension input wrapping change.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.8587f06: Added pagination support toCatalogIndexPageCatalogIndexPagenow offers an optional pagination feature, designed to accommodate adopters managing extensive catalogs. This new capability allows for better handling of large amounts of data.To activate the pagination mode, simply update your
App.tsxas follows:In case you have a custom catalog page and you want to enable pagination, you need to pass the
paginationprop toEntityListProviderinstead.fb8f3bd: Updated alpha translation message keys to use nested format and camel case.531e1a2: Updated alpha plugin to include theunregisterRedirectexternal route.Updated dependencies
v1.15.1Compare Source
v1.15.0Compare Source
Minor Changes
1e5b7d9: Added theDefaultEntityPresentationApi, which is an implementation of theEntityPresentationApithat@backstage/plugin-catalog-reactexposes throughits
entityPresentationApiRef. This implementation is also by default madeavailable 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
eb817ee: Fix spacing inconsistency with links and labels in headers8a84456: Migrate catalog entity cards to new frontend system extension format.e964c17: Use default extensions boundary and suspense on the alpha declarativecreateCatalogFilterExtensionextension factory.71c97e7: The `spec.lifecycle' field in entities will now always be rendered as a string.6c2b872: Add official support for React 18.0bf6ebd: 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.bb98953: Create declarative extensions for theCatalogplugin; this initial plugin preset contains sidebar item, index page and filter extensions, all distributed via/alphasubpath.The
EntityPagewill be migrated in a follow-up patch.7c265b9: Fix type error onCatalogTablewhen using Material UI v569c1490: UseEntityRefLinkswithhideIconsproperty to avoid double icons62b5922: Internal theme type updates77f009b: Internal updates to match changes in the experimental@backstage/frontend-plugin-api.Updated dependencies
v1.14.0Compare Source
Minor Changes
28f1ab2: The catalog plugin no longer implements the experimental reconfiguration API. The create button title can now instead be configured using the new experimental internationalization API, via thecatalogTranslationRefexported at/alpha. For example:f3561a2: include owner chip in catalog search result itemPatch Changes
7c4a8e4: Create an experimentalCatalogSearchResultItemExtensionfor declarative integration with Backstage; it can be accessed via the/alphaimport.0296f27: The `spec.lifecycle' field in entities will now always be rendered as a string.0b55f77: Removed some unused dependencies9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.e5a2956: Migrate catalog api to declarative integration system, it is exported from/alphasubpath.v1.13.0Compare Source
Minor Changes
e44f45a: This change allows a new annotation ofbackstage.io/techdocs-entitythis ref allows you to reference another entity for its TechDocs. This allows you have a single TechDoc for all items in a system, for example you might have a frontend and a backend in the same repo. This would allow you to have TechDocs build under aSystementity while referencing the system e.g.:backstage.io/techdocs-entity: system:default/examplethat will show the systems docs in both the TechDocs button and the TechDocs tab without needing to do duplicate builds and filling the TechDocs page with garbage.Patch Changes
832eef7: Added title to props forHas<kind>Cards.163a410: Fixed an issue whereEntitySwitchwas preventing the display of entity errors.406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v1.12.4Compare Source
Patch Changes
832eef7: Added title to props forHas<kind>Cards.163a410: Fixed an issue whereEntitySwitchwas preventing the display of entity errors.v1.12.3Compare Source
v1.12.2Compare Source
v1.12.1Compare Source
Patch Changes
3d86be9: Prefer simpletheme.spacingwithout string interpolation136cea7: Fixed an issue causingEntitySwitchto unmount its children once entity refresh was invokedv1.12.0Compare Source
Minor Changes
eae0352: Tables which useEntityTablePropsnow have an additionaltableOptionsprop which can be used to provide additional table options to these components.Patch Changes
294b162: Display a warning alert if relations are defined, which don't exist in the catalog.v1.11.2Compare Source
Patch Changes
08f177b: Add link from Template entity to the scaffolder launch page for the template in the AboutCard.2e03636: UpdatedalertApiusages with severity ofinfoorsuccessto usedisplay: transient530b6f3: Adding in type and kind entity details to catalog table title for user clarity8860553:CatalogIndexPagenow accepts an optionalownerPickerModefor toggling the behavior of theEntityOwnerPicker,exposing a new mode
<CatalogIndexPage ownerPickerMode="all" />particularly suitable for larger catalogs. In this new mode,EntityOwnerPickerwill display all the users and groups present in the catalog.47b01e4: Keyboard navigation to open EntityContextMenu now focus visible the first element.v1.11.1Compare Source
Patch Changes
47b01e4: Keyboard navigation to open EntityContextMenu now focus visible the first element.v1.11.0Compare Source
Minor Changes
2258dca: Added an entity namespace filter and column on the default catalog page.If you have a custom version of the catalog page, you can add this filter in your CatalogPage code:
The namespace column can be added using
createNamespaceColumn();. This is only needed if you customized the columns for CatalogTable.Patch Changes
v1.10.0Compare Source
Minor Changes
4dbf3d3: Added a new EntitySwitch isResourceType to allow different views depending on Resource typefc6cab4: AddedisEntityWithcondition helper forEntitySwitchcase statements.Patch Changes
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv1.9.0Compare Source
Minor Changes
23cc400: AllowEntitySwitchto render all cases that match the condition.This change introduces a new parameter for the
EntitySwitchcomponentrenderMultipleMatches. In case the parameter value isall, theEntitySwitchwill render all
EntitySwitch.Casethat containifparameter, and itevaluates to true. In case none of the cases match, the default case will be
rendered, if any.
This means for example in the CI/CD page you can now do the following:
This allows the component to have multiple CI/CD systems and all of those are
rendered on the same page.
3f75b76: Add ability to pass icon as function to have ability to customize it by search itemc9a9f3c: Add acolumnsprop to certain components that use theEntityTablefor easier extensibility.Patch Changes
3fa4169: Make the "Copied!" message disappear automatically after some time7e8930a: Fix icon alignment inCatalogSearchResultListItemdbbde6e: fix entity switch rendering when there is no default casecb8ec97: Change black & white colors to be theme aware928a12a: Internal refactor of/alphaexports.v1.8.0Compare Source
Minor Changes
0c1fc39: Added Markdown support in theAboutCarddescription section0eaa579: TheCatalogSearchResultListItemcomponent is now a search result extension. This means that when rendered as a child of components that render search extensions, theresult,rank, andhighlightproperties are optional. See the documentation for more details.Patch Changes
d7f55f6: The list of entities takes into account the title when its different from the name to sort the entities.66e2aab:ListItemwrapper component moved toSearchResultListItemExtensionfor all*SearchResultListItemsthat are exported as extensions. This is to make sure the list only contains list elements.Note: If you have implemented a custom result list item, we recommend you to remove the list item wrapper to avoid nested
<li>elements.7d46ca2: Make catalog search result list a bit more customizableUpdated dependencies
v1.7.2Compare Source
Patch Changes
cebe24e: AddEntityLabelsCardto show the labels for an entity.5353b4d: There is now tooltip in the entity context menubackstage/backstage (@backstage/plugin-catalog-backend)
v1.23.2Compare Source
Patch Changes
v1.23.1Compare Source
This release fixes an issue with the
@backstage/plugin-auth-backendpackage, in particular theproviderInfonot being set properly for some proxy providers.v1.23.0Compare Source
Minor Changes
c7528b0: Pass throughEventsServicetoo in the new backend systemPatch Changes
8869b8e: Updated local development setup.78a0b08: Internal refactor to handleBackendFeaturecontract change.d44a20a: Added additional plugin metadata topackage.json.d779e3b: Added a regex test to check commit hash. If url is from git commit branch ignore the edit url.6c5cab1: Fix bug ingetLocationByEntity0f55f5c: Ensure name and title are both indexed by the DefaultCatalogCollator1779188: Start using theisDatabaseConflictErrorhelper from the@backstage/backend-plugin-apipackage in order to avoid dependency with the soon to deprecate@backstage/backend-commonpackage.v1.22.0Compare Source
Minor Changes
f2a2a83: Deprecated theLocationAnalyzertype, which has been moved to@backstage/plugin-catalog-node.f2a2a83: The/alphaplugin export has had its implementation of thecatalogAnalysisExtensionPointupdated to reflect the new API.8d14475: Emit well known relationships for the Domain entity kind.Patch Changes
131e5cb: Fix broken links in README.c6cb568: Add lifecycle monitoring for the catalog processingd229dc4: Move path utilities frombackend-commonto thebackend-plugin-apipackage.8479a0b: Fixed bug in stitching queue gauge that included entities that are scheduled in the future.v1.21.1Compare Source
Patch Changes
cfdc5e7: Fixes an issue where/analyze-locationwould incorrectly throw a 500 error on an invalid url.d5a1fe1: Replaced winston logger withLoggerServicec52f7ac: Make entity collection errors a little quieter in the logs.Instead of logging a warning line when an entity has an error
during processing, it will now instead emit an event on the event
broker.
This only removes a single log line, however it is possible to
add the log line back if it is required by subscribing to the
CATALOG_ERRORS_TOPICas shown below.Updated dependencies
v1.21.0Compare Source
Minor Changes
f3e2e86: Added the ability to inject custom permissions from modules, onCatalogBuilderandCatalogPermissionExtensionPointPatch Changes
v1.20.0Compare Source
Minor Changes
f3e2e86: Added the ability to inject custom permissions from modules, onCatalogBuilderandCatalogPermissionExtensionPointPatch Changes
v1.19.0Compare Source
Minor Changes
9c7fb30: Added the ability to inject custom permissions from modules, onCatalogBuilderandCatalogPermissionExtensionPointPatch Changes
v1.18.0Compare Source
Minor Changes
df12231: Allow setting EntityDataParser using CatalogModelExtensionPoint15ba00f: Migrated to support new auth services. TheCatalogBuilder.createmethod now accepts adiscoveryoption, which is recommended to forward from the plugin environment, as it will otherwise fall back to use theHostDiscoveryimplementation.Patch Changes
2bd1410: Removed unused dependencies999224f: Bump dependencyminimatchto v96f830bb: Allow passing optional filter togetEntitiesByRefs0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.b65788b: Move @backstage/repo-tools to dev dependencies280edeb: Add index for original value in search table for faster entity facet responsedad018f: Do not fail on stitching when the entity containsnullvalues associated to deeply nested or long keys.v1.17.3Compare Source
This release provides further fixes for the Gitiles integration, and relaxes the validation of the encoding of all query parameters of the catalog backend as well as allowing
limit=0queries.v1.17.2Compare Source
This release fixes an issue where certain Gerrit integration setups were broken, and where it was not possible to query multiple facets from the catalog at the same time.
v1.17.1Compare Source
This release fixes an issue where the
EntitySwitchcomponent from@backstage/plugin-catalogwas preventing the display of entity errors. It also fixes the alphacatalogModuleTemplateKindexport from@backstage/plugin-scaffolder-backend, which had incorrect plugin and module IDs.v1.17.0Compare Source
Minor Changes
43dad25: Add API to get location by entity126c2f9: Updates the OpenAPI spec to use plugin asinfo.titleinstead of package name.04907c3: Updates the OpenAPI specification title to plugin ID instead of package name.d8a54d0: Adds support for supplying field validators to the new backend's catalog plugin. If you're using entity policies, you should use the newtransformLegacyPolicyToProcessorfunction to install them as processors instead.Patch Changes
9aac2b0: Use--cwdas the firstyarnargument89b674c: Minor performance improvement forqueryEntitieswhen the limit is 0.81e19b1: Replace uses of deprecated types with replacements internally.efa8160: Rollback the change for wildcard discovery, this fixes a bug with theAzureUrlReadernot working with wildcard pathsd208a93: Fixed a bug wherefullTextFilterwasn't preserved correctly in the cursor.6bb6f3e: Updated dependencyfs-extrato^11.2.0.Updated dependency
@types/fs-extrato^11.0.0.1cae748: Updated dependencygit-url-parseto^14.0.0.0a395b3: Upgradedprom-clientto version 159b2eb3f: Add support foronProcessingErrorhandler at the catalog plugin (new backend system).You can use
setOnProcessingErrorHandlerat thecatalogProcessingExtensionPointas replacement for
Updated dependencies
v1.16.2Compare Source
v1.16.1Compare Source
Patch Changes
c3249d6: Parse the URL using a different method rather thangit-url-parseto support wildcards for URLs which are not VCS providersv1.16.0Compare Source
Minor Changes
7804597: Permission rules can now be added for the Catalog plugin through theCatalogPermissionExtensionPointinterface.Patch Changes
3834067: Update the OpenAPI spec to support the use ofopenapi-generator.50ee804: Wrap singlepipelineLoopof TaskPipeline in a span for better traces7123c58: Updated dependency@types/globto^8.0.0.0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617a168507: DeprecatedEntitiesSearchFilterandEntityFilter, which can now be imported from@backstage/plugin-catalog-nodeinsteadv1.15.0Compare Source
Minor Changes
e5bf374: Support adding location analyzers in new catalog analysis extension point and moveAnalyzeOptionsandScmLocationAnalyzertypes to@backstage/plugin-catalog-node8d75696: Introduce a new optional config parametercatalog.stitchingStrategy.mode,which can have the values
'immediate'(default) and'deferred'. The defaultis 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 separateasynchronous 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
6694b36: Update the OpenAPI spec with more complete error responses and request bodies using Optic. Also, updates the test cases to use the newsupertestpass through from@backstage/backend-openapi-utils.013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.v1.14.0Compare Source
Minor Changes
78af943: Instrumenting some missing metrics withOpenTelemetryPatch Changes
7a2e292: Marked theLocationEntityProcessoras deprecated, as it is no longer used internally since way back and can even be harmful at this point.0b55f77: Removed some unused dependencies348e8c1: Fixes a bug where eagerly deleted entities did not properly trigger re-stitching of entities that they had relations to.b97e979: Internal refactors, laying the foundation for later introducing deferred stitching (see #18062).v1.13.3Compare Source
v1.13.2Compare Source
This release includes the missing
@rjsf/*dependencies from@backstage/plugin-homewhich fixes issues likeCannot read properties of undefined (reading 'isMultiSelect')v1.13.1Compare Source
This release bumps the minimum required version of
vm2to 3.9.17v1.13.0Compare Source
Minor Changes
62f448e: Allow configuring the processing interval in your app-config, under thecatalog.processingIntervalkey.09cfc3c: set azure annotationdev.azure.com/project-repoinAnnotateScmSlugEntityProcessorto find the project and repo information for the repos that containsdev.azure.comin the urlPatch Changes
149361e: Fix to thelimitparameter on entity queries.1fd2109: Changed the processing loop task pipeline implementation from recursive to iterative71114ac: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
0f8a977: Update OpenAPI schema to relax the encoding validation of all request parameters.0198aa5: Fixed a link to the frontend Backstage plugin that had pointed to itself.2d32d8a: Fixed validation of thefullTextFilterFieldsquery parameter.acffa17: Added some examples to the catalog OpenAPI definition45947d3: Fixes an issue whereorderwas not a recognized parameter for the/entitiesendpoint.41d1b2d: Fix OpenAPI schema for the facets endpoint618257f: Fix issue withcatalogFileNamenot being a required property for/analyze-locationcfc3ca6: Changes needed to support MySQL814feee: Update to handle invalid luxon valuesUpdated dependencies
v1.12.4Compare Source
v1.12.3Compare Source
v1.12.2Compare Source
Patch Changes
149361e: Fix to thelimitparameter on entity queries.0198aa5: Fixed a link to the frontend Backstage plugin that had pointed to itself.41d1b2d: Fix OpenAPI schema for the facets endpointcfc3ca6: Changes needed to support MySQLv1.12.1Compare Source
This release fixes an issue where the backend start command would not work on Windows.
v1.12.0Compare Source
Minor Changes
b8cccd8: Support configuring applicable kinds forAnnotateScmSlugEntityProcessorf32252c: Added OpenTelemetry spans for catalog processingebeb775: Now performs request validation based on OpenAPI schema through@backstage/backend-openapi-utils. Error responses for invalid input, like"a"instead of a number, may have changed.Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.configb8d6b22: Internal refactor for load testv1.11.0Compare Source
Minor Changes
f06f0e4: Support placeholder resolvers in the CatalogPlugin, also movesPlaceholderResolverand related types from@backstage/plugin-catalog-backendto@backstage/plugin-catalog-node.Patch Changes
v1.10.0Compare Source
Minor Changes
44c7ad6: Adds an optionalEventBrokerthat is used for sending an event when there are conflicts, with details of the conflict so that it can be handled elsewhere.Patch Changes
77e04a2: Replace getBearerToken with library function of sameee411e7: Update OpenAPI specs to be in line with linting standards.b8374d5: Add a base plate for performance testing of the catalogv1.9.1Compare Source
Patch Changes
ce8d203: Ensure that entity cache state is only written to the database when actually changed485a6c5: Internal refactoring for performance in the service handlers3587a96: Fixed a bug in thequeryEntitiesendpoint that was causing filtered entities to be included in cursor requests.ce335df: Improve the query for orphan pruning27956d7: Adjusted the OpenAPI schema file name according to the new structure51064e6: Change orphan cleanup task to only log a message if it deleted entities.12a3453: Remove unnecessary join in the entity facets endpoint, exclude nullsv1.9.0Compare Source
Minor Changes
329b63f: The catalog now has a new, optionalcatalog.orphanStrategyapp-config parameter, which can have the string values'keep'(default) or'delete'.If set to
'keep'or left unset, the old behavior is maintained of keeping orphaned entities around until manually deleted.If set to
'delete', the catalog will attempt to automatically clean out orphaned entities without manual intervention. Note that there are no guarantees that this process is instantaneous, so there may be some delay before orphaned items disappear.For context, the Life of an Entity article goes into some more details on how the nature of orphaning works.
To enable the new behavior, you will need to pass the plugin task scheduler to your catalog backend builder. If your code already looks like this, you don't need to change it:
But if you pass things into the catalog builder one by one, you'll need to add the new field:
Finally adjust your app-config:
92a4590: Add monorepo support to CodeOwnersProccesor.Patch Changes
62a725e: Use theLocationSpectype from thecatalog-commonpackage in place of the deprecatedLocationSpecfrom thecatalog-nodepackage.be5aca5: Updates and moves OpenAPI spec tosrc/schema/openapi.yamland usesApiRoutertype from@backstage/backend-openapi-utilsto handle automatic types from the OpenAPI spec file.c9a0fdc: Fix deprecated types.899ebfd: Add full text search support to theby-queryendpoint.1e4f5e9: Bumpzodandzod-to-json-schemadependencies.c4b8463: Allow replacement of the BuiltinKindsEntityProcessor which enables customization of schema validation and connections emitted.c36b89f: Fixed bug in theDefaultCatalogProcessingEnginewhere entities that contained multiple different types of relations for the same source entity would not properly trigger stitching for that source entity.01ae205: Collator factories instantiated in new backend system modules and now marked as deprecated. Will be continued to be exported publicly until the new backend system is fully rolled out.v1.8.0Compare Source
Minor Changes
7f4ea3d: Add /entities/by-query endpoint returning paginated entities.The endpoint supports cursor base pagination and server side sorting of the entities
Patch Changes
e675f90: Add deprecations for symbols that were moved to@backstage/plugin-catalog-nodea long time ago:CatalogProcessorCatalogProcessorCacheCatalogProcessorEmitCatalogProcessorEntityResultCatalogProcessorErrorResultCatalogProcessorLocationResultCatalogProcessorParserCatalogProcessorRefreshKeysResultCatalogProcessorRelationResultCatalogProcessorResultDeferredEntityEntityProviderEntityProviderConnectionEntityProviderMutationEntityRelationSpecprocessingResultAlso moved over and deprecated the following symbols:
locationSpecToLocationEntitylocationSpecToMetadataNameac8929f: Fix export ofdefaultCatalogCollatorEntityTransformer.928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.f093ce8: Fix a bug where the batch fetch by ref endpoint did not work in conjunction with filtering (e.g. if authorization was enabled).Updated dependencies
v1.7.2Compare Source
Patch Changes
071354e: Add additional validation as security precations for output entities.b977c2e: Minor improvements to the descriptions provided with permission rules schemas2380506: The process of adding or modifying fields in the software-catalog search index has been simplified. For more details, see how to customize fields in the Software Catalog index.9573651: The previous migration that adds thesearch.original_valuecolumn may leave some of the entities not updated. Add a migration script to trigger a reprocessing of the entities.9f71a2f: Location rule target patterns now also match hidden files, i.e. path components with a leading dot.e716946: Updated usage of the lifecycle service.1aec041: Fixed an issue where entities sometimes were not properly deleted during a full mutation.0ff0331: Updated usage ofcreateBackendPlugin.fc73f6a: Switched the order of reprocessing statements retroactively in migrations. This only improves the experience for those who at a later time perform a large upgrade of an old Backstage installation.v1.7.1Compare Source
This release fixes an issue where
@backstage/create-appunintentionally required Git to be set up for it to be able to create a new project.v1.7.0Compare Source
Minor Changes
f75bf76: Implemented server side ordering in the entities endpointPatch Changes
e23f13a: Enable theby-refsendpoint to receivefieldsthrough the POST body as well as through query parameters.f23eef3: Updated dependencybetter-sqlite3to^8.0.0.d136793: Fixed an issue where internal references in the catalog would stick around for longer than expected, causing entities to not be deleted or orphaned as expected.8e06f3c: Switched imports ofloggerToWinstonLoggerto@backstage/backend-common.backstage/backstage (@backstage/plugin-catalog-backend-module-github)
v0.6.4Compare Source
Patch Changes
v0.6.3Compare Source
v0.6.2Compare Source
Patch Changes
78a0b08: Internal refactor to handleBackendFeaturecontract change.d44a20a: Added additional plugin metadata topackage.json.67d0530: Fix bug in root repo import where catalog-info.yaml.hcl file is found by search and breaks the importv0.6.1Compare Source
Patch Changes
0b50143: GitHub push events now schedule a refresh on entities that have arefresh_keymatching thecatalogPathconfig itself.This allows to support a
catalogPathconfiguration that uses glob patterns.f2a2a83: Updated to use the newcatalogAnalysisExtensionPointAPI.5bdeaa7: AddedalwaysUseDefaultNamespaceoption toGithubMultiOrgEntityProvider.If set to true, the provider will use
defaultas the namespace for all group entities. Groups with the same name across different orgs will be considered the same group.Updated dependencies
backstage/backstage (@backstage/plugin-catalog-common)
v1.0.24Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.v1.0.23Compare Source
Patch Changes
v1.0.22Compare Source
Patch Changes
v1.0.21Compare Source
Patch Changes
v1.0.20Compare Source
Patch Changes
v1.0.19Compare Source
Patch Changes
v1.0.18Compare Source
Patch Changes
v1.0.17Compare Source
Patch Changes
v1.0.16Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v1.0.15Compare Source
Patch Changes
v1.0.14Compare Source
Patch Changes
v1.0.13Compare Source
Patch Changes
v1.0.12Compare Source
Patch Changes
928a12a: Internal refactor of/alphaexports.v1.0.11Compare Source
Patch Changes
v1.0.10Compare Source
Patch Changes
backstage/backstage (@backstage/plugin-catalog-graph)
v0.4.6Compare Source
Patch Changes
8d474d3: Add function toEntityRelationsGraphfilter that excludes entities from graphd44a20a: Added additional plugin metadata topackage.json.cd6aeea: ThecatalogEntityexternal route will now by default bind to the catalog entity page if it is available.v0.4.5Compare Source
Patch Changes
39564b3: Allow multiple edges with different type (e.g.ownedByandapplicationOwnerBy) to have the same source and target node.v0.4.4Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.backstage/backstage (@backstage/plugin-catalog-import)
v0.12.0Compare Source
Minor Changes
4f92394: Migrate from identityApi to fetchApi in frontend plugins.Patch Changes
d44a20a: Added additional plugin metadata topackage.json.3daad61: Integrated Azure DevOps as a catalog import source. This enables Backstage to create Pull Requests to Azure DevOps repositories as it does with GitHub repositoriesbackstage/backstage (@backstage/plugin-catalog-react)
v1.12.1Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.fa8560e: Prevents Autocomplete dropdown from overlapping sidebar on hovering itv1.12.0Compare Source
Minor Changes
8834daf: Updated the presentation API to return a promise, in addition to the snapshot and observable that were there before. This makes it much easier to consume the API in a non-React context.Patch Changes
v1.11.3Compare Source
Patch Changes
47dec6f: Added theno-top-level-material-ui-4-importsESLint rule to aid with the migration to Material UI v5b863830: Change behavior in EntityAutoCompletePicker to only hide filter if there are no available options. Previously the filter was hidden if there were <= 1 available options.abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.v1.11.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryb5cbbb6:EntitySearchBarandEntityTextFilterhave been updated accordingly to persist the status as query params, following the same pattern as the other server sidev1.11.1Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.11.0Compare Source
Minor Changes
72b8827: Number of results is now directly added as the fieldtotalItemsonuseEntityList.Patch Changes
930b5c1: Added 'root' and 'label' class keys for EntityAutocompletePicker, EntityOwnerPicker and EntityProcessingStatusPickerb2a9926: Adds an argument for which filters should be applied when fetching/counting available valuesa6e237f: AddedDefaultFilterscomponent298953b: Added support for providing aninitiallySelectedNamespaceswhich accepts an array of Namespaces to have selected by defaultv1.10.0Compare Source
Minor Changes
d208a93: Added support for server side text filtering to paginated entity requests.3dc64e9: Add support toconfigSchemaoption on thecreateEntityCardExtensionfactory function.Patch Changes
916da47: Change default icon for unknown entities to nothing instead of the help icon.71c6d7a: Overflowing labels in OwnerPicker (Catalog) are now truncated. Hovering over them shows the full label8fe56a8: Widen@types/reactdependency range to include version 18.09cedb9: Updated dependency@react-hookz/webto^24.0.0.v1.9.3Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.9.2Compare Source
Patch Changes
8587f06: Added pagination support toEntityListProvider.5360097: Ensure that passed-in icons are taken advantage of in the presentation APIfd9863c: Grouped all/alphaextension data reference exports undercatalogExtensionData.08d9e67: Add default icon for kind resource.aaa6fb3: Minor updates for TypeScript 5.2.2+ compatibilitya5a0473: Internal refactor of alpha exports due to a change in how extension factories are defined.4d9e3b3: Register component overrides in the globalOverrideComponentNameToClassKeysprovided by@backstage/theme. This will in turn will provide component style override types forcreateUnifiedTheme.8f5d6c1: Updates to the/alphaexports to match the extension input wrapping change.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.e223f22: Breaking alpha-API change to entity visibility filter functions to accept a bare entity as their first argument, instead of an object with an entity property.Functions that accept such filters now also support the string expression form of filters.
eee0ff2: Fixed a issue whereCatalogPagewasn't using the choseninitiallySelectedFilteras intended.Updated dependencies
v1.9.1Compare Source
This release fixes an issue where we accidentally released a change for
A11ythat meant that someSidebarItemswere being uppercased accidentally.v1.9.0Compare Source
Minor Changes
1e5b7d9: Added anEntityPresentationApiand associatedentityPresentationApiRef. ThisAPI 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
EntityRefLinkandEntityRefLinkscomponents, so that they can render richer, more correct representation of
entity refs. There's also a new
EntityDisplayNamecomponent, which works just likethe
EntityRefLinkbut without the link.Along with that change, the
fetchEntitiesandgetTitleprops ofEntityRefLinksPropsare deprecated and no longer used, since the same needinstead is fulfilled (and by default always enabled) by the
entityPresentationApiRef.1fd53fa: TheUserListPickercomponent 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 theEntityListContextfor 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,EntityLifecycleFilterandEntityNamespaceFilterhave now thegetCatalogFiltersmethod implemented.Patch Changes
2ad1bac: Add EntityRef to Entity Inspector UI6c2b872: Add official support for React 18.69ee8d7: Removebuttonprop from used MaterialUIMenuItemcomponent fixing incompatibility with MaterialUI v5.0bf6ebd: Added new APIs at the/alphasubpath for creating entity page cards and content for the new frontend system.77f009b: Internal updates to match changes in the experimental@backstage/frontend-plugin-api.71c97e7: Thespec.typefield in entities will now always be rendered as a string.69c1490: Move theEntityRefLinkicon to the left hand side as per Material-UI guidelines000dcd0: Removed unnecessary@backstage/integrationdependency, replaced by@backstage/integration-react.6c35718: ExportMissingAnnotationEmptyStatefrom@backstage/plugin-catalog-reactv1.8.5Compare Source
Patch Changes
a402e1d: Fixed an issue causingEntityPageto show an error for entities containing special characters0b55f77: Removed some unused dependencies9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.0296f27: Thespec.typefield in entities will now always be rendered as a string.v1.8.4Compare Source
Patch Changes
bd81720: Export theEntityAutocompletePickercomponent.406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.7029ba1: Added delete alert popup when user delete the entityv1.8.3Compare Source
Patch Changes
v1.8.2Compare Source
This release fixes an issue where we inadvertently released a change to the ESLint configuration in the
@backstage/clithat we did not intend to release.v1.8.1Compare Source
Patch Changes
aa3feed: Allow specifying screen size when catalog filters are hidden in drawerv1.8.0Compare Source
Minor Changes
eae0352: Tables which useEntityTablePropsnow have an additionaltableOptionsprop which can be used to provide additional table options to these components.Patch Changes
v1.7.0Compare Source
Minor Changes
cb4c159: TheEntityOwnerPickercomponent has undergone improvements to enhance its performance.The previous implementation inferred users and groups displayed by the
EntityOwnerPickercomponent based on the entities available in theEntityListContext. The updated version no longer relies on theEntityListContextfor inference, allowing for better decoupling and improved performance.The component now loads entities asynchronously, resulting in improved performance and responsiveness. A new
modeprop has been introduced which provides two different behaviours:<EntityOwnerPicker mode="owners-only" />: loads the owners data asynchronously using the facets endpoint. The data is kept in memory and rendered asynchronously as the user scrolls. This is the default mode and is supposed to be retro-compatible with the previous implementation.<EntityOwnerPicker mode="all" />loads all users and groups present in the catalog asynchronously. The data is loaded in batches as the user scrolls. This is more efficient thanowners-only, but has the drawback of displaying users and groups who aren't owner of any entity.Patch Changes
d68692a: MakeuseRelatedEntitiesusegetEntitiesByRefsunder the hood429319d:EntityAutocompletePickeraddinitialSelectedOptionsprop429319d:EntityLifecycleFilterloads data using the facets endpointv1.6.0Compare Source
Minor Changes
2258dca: Added an entity namespace filter and column on the default catalog page.If you have a custom version of the catalog page, you can add this filter in your CatalogPage code:
The namespace column can be added using
createNamespaceColumn();. This is only needed if you customized the columns for CatalogTable.Patch Changes
v1.5.0Compare Source
Minor Changes
a49fb39: Attempt to load entity owner names in the EntityOwnerPicker through theby-refsendpoint. Ifspec.profile.displayNameormetadata.titleare populated, we now attempt to show those before showing thehumanizeEntityRef'd version.BREAKING:
EntityOwnerFilternow uses the full entity ref instead of thehumanizeEntityRef. If you rely onEntityOwnerFilter.valuesor thequeryParameters.ownersofuseEntityList, you will need to adjust your code like the following.Patch Changes
81bee24: Fixed bug in catalog filters where you could not click on the text to select a value.8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)d1f5324: Reverted the check if the selected options list is different than the query parameters list before invokingsetSelectedOptionsmethod. This was preventing updating list items when a query string was already present in the URL when loading the page.2898b6c: Minor type tweaks for TypeScript 5.0e0c6e8b: Update peer dependenciesv1.4.0Compare Source
Minor Changes
0a5b73b: Add possibility to re-use EntityPicker for filters with multiple select.Patch Changes
6545487: Minor API report tweaks928a12a: Internal refactor of/alphaexports.24916d2: Do not closeAutocompletepowered multiple-selection filters when checking boxesv1.3.0Compare Source
Minor Changes
929e1af: AddinitialFilterprop to EntityLifecyclePicker. This allows you to set an initial lifecycle for the catalog.fab93c2: Aligned buttons on "Unregister entity" dialog to keep them on the same linePatch Changes
v1.2.4Compare Source
Patch Changes
37426f6: Fixed bug inEntityTagPickerthat filtered on unavailable tags for the selected kind.516b203: Add a reusable pop overEntityPeekAheadPopovercomponent. It shows more details about the associated entity. See the playbook here https://backstage.io/storybook/?path=/story/catalog-entitypeekaheadpopover--default0e33627: Remove usage of raw spanbackstage/backstage (@backstage/plugin-github-actions)
v0.6.16Compare Source
v0.6.15Compare Source
backstage/backstage (@backstage/plugin-org)
v0.6.26Compare Source
Patch Changes
d8e2f53: ThecatalogIndexexternal route is now optional and will by default bind to the catalog index page if it is available.d44a20a: Added additional plugin metadata topackage.json.v0.6.25Compare Source
Patch Changes
99e6105: Fix ownership card sometimes locking up for complex org structuresv0.6.24Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.backstage/backstage (@backstage/plugin-permission-common)
v0.7.14Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.backstage/backstage (@backstage/plugin-permission-node)
v0.7.32Compare Source
Patch Changes
v0.7.31Compare Source
v0.7.30Compare Source
Patch Changes
9e63318: Ensure that service token access restrictions, when present, are taken into accountd44a20a: Added additional plugin metadata topackage.json.c7b0dd1: ImporttokenManagerdefinition from@backstage/backend-plugin-apiv0.7.29Compare Source
Patch Changes
v0.7.28Compare Source
Patch Changes
29fa05b: Fixed an issue causingServerPermissionClientto generate an invalid token for authorizing permissions against the permission backend.backstage/backstage (@backstage/plugin-permission-react)
v0.4.23Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.v0.4.22Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.v0.4.21Compare Source
Patch Changes
v0.4.20Compare Source
Patch Changes
8fe56a8: Widen@types/reactdependency range to include version 18.v0.4.19Compare Source
Patch Changes
4016f21: Remove some unused dependenciesb1acd9b: Updated READMEv0.4.18Compare Source
Patch Changes
v0.4.17Compare Source
Patch Changes
6c2b872: Add official support for React 18.4aa43f6: Updated dependencycross-fetchto^4.0.0.v0.4.16Compare Source
Patch Changes
9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.v0.4.15Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v0.4.14Compare Source
Patch Changes
v0.4.13Compare Source
Patch Changes
v0.4.12Compare Source
Patch Changes
e0c6e8b: Update peer dependenciesv0.4.11Compare Source
Patch Changes
v0.4.10Compare Source
Patch Changes
v0.4.9Compare Source
Patch Changes
1a53a73: Updated dependencyswrto^2.0.0.backstage/backstage (@backstage/plugin-proxy-backend)
v0.5.2Compare Source
Patch Changes
v0.5.1Compare Source
v0.5.0Compare Source
Minor Changes
88480e4: BREAKING: The proxy backend plugin is now protected by Backstage auth, bydefault. Unless specifically configured (see below), all proxy endpoints will
reject requests immediately unless a valid Backstage user or service token is
passed along with the request. This aligns the proxy with how other Backstage
backends behave out of the box, and serves to protect your upstreams from
unauthorized access.
A proxy configuration section can now look as follows:
There are three possible
credentialssettings at this point:require: Callers must provide Backstage user or service credentials witheach request. The credentials are not forwarded to the proxy target.
forward: Callers must provide Backstage user or service credentials witheach request, and those credentials are forwarded to the proxy target.
dangerously-allow-unauthenticated: No Backstage credentials are required toaccess this proxy target. The target can still apply its own credentials
checks, but the proxy will not help block non-Backstage-blessed callers. If
you also add
allowedHeaders: ['Authorization']to an endpoint configuration,then the Backstage token (if provided) WILL be forwarded.
The value
dangerously-allow-unauthenticatedwas the old default.The value
requireis the new default, so requests that were previouslypermitted may now start resulting in
401 Unauthorizedresponses. If you havebackend.auth.dangerouslyDisableDefaultAuthPolicyset totrue, this does notapply; the proxy will behave as if all endpoints were set to
dangerously-allow-unauthenticated.If you have proxy endpoints that require unauthenticated access still, please
add
credentials: dangerously-allow-unauthenticatedto their declarations inyour app-config.
Patch Changes
8869b8e: Updated local development setup.78a0b08: Internal refactor to handleBackendFeaturecontract change.d44a20a: Added additional plugin metadata topackage.json.v0.4.16Compare Source
Patch Changes
v0.4.15Compare Source
Patch Changes
e5a2ccc: Updated dependency@types/http-proxy-middlewareto^1.0.0.43ca784: Updated dependency@types/yupto^0.32.0.backstage/backstage (@backstage/plugin-scaffolder)
v1.22.0Compare Source
Minor Changes
52b6db0: Use virtualization withEntityPickeras done earlier withMultiEntityPickerto fix performance issues with large data sets.VirtualizedListboxextracted into reusable component.3583ce5: Use virtualization withMultiEntityPicker. Fixes performance issues with large data sets.b5deed0: Add support forbitbucketCloudautocomplete inRepoUrlPickerPatch Changes
661b354: Fixed a bug where theRepoUrlPickerwould still require theownerfield forazure89c44b3: SupportcatalogFilterarray onOwnedEntityPickerv1.21.0Compare Source
Minor Changes
d57ebbc: Changed the way to display entities in EntityPicker to use entityPresentationApi instead of humanizeEntityRef62bd9eb: Replaceui:widget: passwordwith the a warning message stating that it's not secure and to use the build inSecretField.You can do this by updating your
template.yamlfiles that have the referenceui:widget: passwordtoui:field: Secretinstead.60085dd: Added the following default targets for external routes:registerComponentbinds to the catalog import page.viewTechDocbinds to the TechDocs entity documentation page.Patch Changes
cbebad1: Internal updates to allow reusing Backstage'sfetchApiimplementation for event source requests. This allows you to for example, override theAuthorizationheader.1ea7679: Removed waiting for the workspace and repository fields to be filled in before requesting user credentialsd44a20a: Added additional plugin metadata topackage.json.6cb4886: Updated dependency@rjsf/utilsto5.18.4.Updated dependency
@rjsf/coreto5.18.4.Updated dependency
@rjsf/material-uito5.18.4.Updated dependency
@rjsf/validator-ajv8to5.18.4.75dcd7e: Fixing bug informDatatype as it should beoptionalas it's possibly undefinedbcec60f: updated the ContextMenu, ActionsPage, OngoingTask and TemplateCard frontend components to support the new scaffolder permissions:scaffolder.task.createscaffolder.task.cancelscaffolder.task.read612a453: Change owner to project for azure hostUpdated dependencies
v1.20.1Compare Source
Patch Changes
612a453: Change owner to project for azure hostv1.20.0Compare Source
Minor Changes
4268696:MultiEntityPickerusesEntityDisplayNameinstead ofhumanizeEntityRefto display entity.Patch Changes
9156654: Capturing more event clicks for scaffolder131e5cb: Fix broken links in README.0040ec2: Updated dependency@rjsf/utilsto5.18.2.Updated dependency
@rjsf/coreto5.18.2.Updated dependency
@rjsf/material-uito5.18.2.Updated dependency
@rjsf/validator-ajv8to5.18.2.762141c: Fixed a bug where theMultiEntityPickerwas not able to be set as requiredv1.19.3Compare Source
Patch Changes
4f1f6ca: Use default value forMyGroupsPickerif provided605c971: Allow the task list search to work on the Scaffolder template title.abfbcfc: Updated dependency@testing-library/reactto^15.0.0.87d2eb8: Updated dependencyjson-schema-libraryto^9.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.419e948: Don't show login prompt if token is set in the statev1.19.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.19.1Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.19.0Compare Source
Minor Changes
a3b4d90: Added a menu to the header of template page for direct access to editing the templatePatch Changes
0cecb09: Updated dependency@rjsf/utilsto5.17.1.Updated dependency
@rjsf/coreto5.17.1.Updated dependency
@rjsf/material-uito5.17.1.Updated dependency
@rjsf/validator-ajv8to5.17.1.a7e6fb3: Added theno-top-level-material-ui-4-importsESLint rule to aid with the migration to Material UI v5v1.18.0Compare Source
Minor Changes
c56f1a2: Remove the old legacy exports from/alpha9b9c05c: Updating theEntityPickerto only selectkindmetadata.nameandmetadata.namespaceby default to improve performance on larger datasets.a86920b: Introduced a newMultiEntityPickerfield that supports selecting multiple Entities7f11009: Added stack trace display toErrorPageand updated existing refsPatch Changes
b0d1d80: Added basic support for the new frontend system, exported from the/alphasubpath.9aac2b0: Use--cwdas the firstyarnargument912ca7b: UseconvertLegacyRouteRefsto define routes in/alphaexport plugin.da059d7: Removed alpha symbol from Task List header8fe56a8: Widen@types/reactdependency range to include version 18.31f0a0a: AddedScaffolderPageContextMenutoActionsPage,ListTaskPage, andTemplateEditorPageso that you can more easily navigate between these pages09cedb9: Updated dependency@react-hookz/webto^24.0.0.e6f0831: Updated dependency@rjsf/utilsto5.17.0.Updated dependency
@rjsf/coreto5.17.0.Updated dependency
@rjsf/material-uito5.17.0.Updated dependency
@rjsf/validator-ajv8to5.17.0.6a74ffd: Updated dependency@rjsf/utilsto5.16.1.Updated dependency
@rjsf/coreto5.16.1.Updated dependency
@rjsf/material-uito5.16.1.Updated dependency
@rjsf/validator-ajv8to5.16.1.1cae748: Updated dependencygit-url-parseto^14.0.0.11b9a08: Introduced the first version of recoverable tasks.3dff4b0: Remove unused depsv1.17.1Compare Source
Patch Changes
98ac5ab: Updated dependency@rjsf/utilsto5.15.1.Updated dependency
@rjsf/coreto5.15.1.Updated dependency
@rjsf/material-uito5.15.1.Updated dependency
@rjsf/validator-ajv8to5.15.1.4016f21: Remove some unused dependenciesdf4bc9d: Minor internal refactorv1.17.0Compare Source
Minor Changes
df88d09: Add a new git repository url picker forgitea. ThisGiteaRepoPickercan be used in a template to scaffold a project to be cloned using gitea.33edf50: Added support for dealing with user provided secrets using a new field extensionui:field: SecretPatch Changes
6806d10: AddedheaderOptionstoTemplateListPageto optionally override default values.Changed
themeIdof TemplateListPage fromwebsitetohome.aaa6fb3: Minor updates for TypeScript 5.2.2+ compatibility2b72591: Updated dependency@rjsf/utilsto5.14.3.Updated dependency
@rjsf/coreto5.14.3.Updated dependency
@rjsf/material-uito5.14.3.Updated dependency
@rjsf/validator-ajv8to5.14.3.6cd12f2: Updated dependency@rjsf/utilsto5.14.1.Updated dependency
@rjsf/coreto5.14.1.Updated dependency
@rjsf/material-uito5.14.1.Updated dependency
@rjsf/validator-ajv8to5.14.1.a518c5a: Updated dependency@react-hookz/webto^23.0.0.64301d3: Updated dependency@rjsf/utilsto5.15.0.Updated dependency
@rjsf/coreto5.15.0.Updated dependency
@rjsf/material-uito5.15.0.Updated dependency
@rjsf/validator-ajv8to5.15.0.63c494e: Updated dependency@rjsf/utilsto5.14.2.Updated dependency
@rjsf/coreto5.14.2.Updated dependency
@rjsf/material-uito5.14.2.Updated dependency
@rjsf/validator-ajv8to5.14.2.b5fa691: FixingheaderOptionsnot being passed through theTemplatePagecomponentc8908d4: Use new option from RJSF 5.150cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v1.16.1Compare Source
v1.16.0Compare Source
Minor Changes
f28c117: Add a possibility to use a formatter on a warning panel. Applied it for a scaffolder template3fdffbb: Release design improvements for theScaffolderplugin 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
nextversions likecreateNextFieldExtensionandNextScaffolderPagehave been promoted to the public interface undercreateScaffolderFieldExtensionandScaffolderPage, so any older imports which are no longer found will need updating from@backstage/plugin-scaffolder/alphaor@backstage/plugin-scaffolder-react/alphawill need to be imported from@backstage/plugin-scaffolderand@backstage/plugin-scaffolder-reactrespectively.The legacy versions are now available in
/alphaundercreateLegacyFieldExtensionandLegacyScaffolderPageif you're running into issues, but be aware that these will be removed in a next mainline release.Patch Changes
6c2b872: Add official support for React 18.69ee8d7: Removebuttonprop from used MaterialUIMenuItemcomponent fixing incompatibility with MaterialUI v5.c838da0: Updated dependency@rjsf/utilsto5.13.6.Updated dependency
@rjsf/coreto5.13.6.Updated dependency
@rjsf/material-uito5.13.6.Updated dependency
@rjsf/validator-ajv8to5.13.6.26e4d91: Title and description in RepoUrlPicker are now correctly displayed.69c1490: UseEntityRefLinkswithhideIconsproperty to avoid double icons62b5922: Internal theme type updatesv1.15.1Compare Source
Patch Changes
b337d78: fixed issue related template editor fails with multiple templates per file.ff2ab02: Make entity picker more reliable with only one available entity83e4a42: Display log visibility button on the template panel9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.4c70fe4:RepoUrlPickerRepoNamenow correctly handles value changes in allowed repos.v1.15.0Compare Source
Minor Changes
0119c32: adding a .zip download to dry run results page, including zip.js as dependencyPatch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.6e69c11: Restored functionality toOwnedEntityPickerby converting deprecatedui:optionsinput tocatalogFilter.8cec766: Removed@types/nodedependencyb16c341: Updated dependency@rjsf/utilsto5.13.0.Updated dependency
@rjsf/core-v5tonpm:@​rjsf/core@5.13.0.Updated dependency
@rjsf/material-ui-v5tonpm:@​rjsf/material-ui@5.13.0.Updated dependency
@rjsf/validator-ajv8to5.13.0.v1.14.4Compare Source
Patch Changes
v1.14.3Compare Source
v1.14.2Compare Source
Patch Changes
8a0490f: Fix the get entities query in theMyGroupsPickerto query thekind=Groupentities.v1.14.1Compare Source
Patch Changes
v1.14.0Compare Source
Minor Changes
464125e: AddedMyGroupsPickerfield extension that will display a dropdown of groups a user is part of.Patch Changes
cda753a: ForwardAuthorizationheader forEventSourcewhen credentials are available.2ff94da: bumprjsfdependencies to 5.7.374b216e: AddPropsWithChildrento usages ofComponentType, in preparation for React 18 where the children are no longer implicit.v1.13.1Compare Source
Patch Changes
d560d45: Fix case GitLab workspace is a nested subgroupad1a142: Improvements to thescaffolder/nextbuttons UX:SteppercomponentOngoingTaskcomponent. The state of these buttons match their existing counter parts in the Context MenuContextMenucomponentUpdated dependencies
v1.13.0Compare Source
Minor Changes
b71f58d: Fixed bug in EntityPicker component that allowed for empty values when field is required. This bug occurs only after a user fills the EntityPicker field, clears it, and then continues to the next form step.cdab34f: scaffolder/next: removing therouteRefsand exporting the originals onscaffolderPlugin.routes.xinsteade5ad1bd: AllowTemplateListPageandTemplateWizardPageto be passed in as props92cf86a: Added atemplateFilterprop to the<Router/>component to allow for filtering of templates through a function.cf18c32: The Installed Actions page now shows details for nested objects and arrays259d340: MoveCategoryPickerfromscaffolderintoscaffolder-reactMove
ContextMenuintoscaffolder-reactand rename it toScaffolderPageContextMenuPatch Changes
7e1d900:scaffolder/next: Bump@rjsf/*dependencies to 5.5.2e27ddc3: Added a possibility to cancel the running task (executing of a scaffolder template)57c1b47: Allow use of{ exists: true }value inside filters to filter entities that has that key.this example will filter all entities that has the annotation
someAnnotationset to any value.7917cfc: Fix some hard-coded white font colors in scaffolder0435174: Accessibility issues identified using lighthouse fixed.7a6b16c:scaffolder/next: Bump@rjsf/*deps to 5.3.190dda42: bug: InverttemplateFilterpredicate to align withArray.filter1e4f5e9: Bumpzodandzod-to-json-schemadependencies.f84fc7f: Updated dependency@rjsf/validator-ajv8to5.3.0.8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)34dab7e:scaffolder/next: bumprjsfdependencies to5.5.0e0c6e8b: Update peer dependenciescf71c37: scaffolder/next: Bump@rjsf/*dependencies to 5.6.0Updated dependencies
v1.12.0Compare Source
Minor Changes
0d61fcc: UpdateEntityPickerto use the fully qualified entity ref instead of the humanized version.8f4d13f: MoveuseTaskStream,TaskBorder,TaskLogStreamandTaskStepsintoscaffolder-react.Patch Changes
6545487: Minor API report tweaks3c96e77: Make scaffolder adhere to page themes by using pagefontColorconsistently. If your theme overwrites template list or card headers, review those styles.be3cdda: Getting credentials in the RepoUrlPicker now also works for targets without owner (e.g. Bitbucket Server).cb8ec97: Change black & white colors to be theme awareeb877ba: Create an "Other Templates" group when groups are given to scaffolder/next.c10384a: Switch to usingLinkButtoninstead of the deprecatedButton928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.0aae459: Fix the scaffolder validator for arrays when the item is a field in the objectv1.11.0Compare Source
Minor Changes
d6bb12a: - Deprecation - Deprecated the following exports, please import them directly from@backstage/plugin-scaffolder-reactinsteada521379: Migrating theTemplateEditorPageto work with the new components from@backstage/plugin-scaffolder-react074f7e8: Added a missing validator check for items in an array8c29665: Embed scaffolder workflow in other componentsPatch Changes
04f717a:scaffolder/next: bumpreact-jsonschema-formlibraries tov5-stableb46f385: scaffolder/next: Implementing a simpleOngoingTaskpagecbab8ac: lock versions of@rjsf/*-betapackages346d6b6: Upgrade@rjsfversion 5 dependencies tobeta.18ccbf910: bump@rjsfv5dependencies to 5.1.0d2ddde2: AddScaffolderLayoutstoNextScaffolderPage0f0da2f: Prefer schema ordering of template properties during review content generation.38992bd: Fixed bug in review step refactor that caused schema-based display settings for individual property values to be discarded.v1.10.1Compare Source
@rjsf/*libraries were incompatiblev1.10.0Compare Source
Minor Changes
e4c0240: AddedcatalogFilterfield to OwnerPicker and EntityPicker components to support filtering options by any field(s) of an entity.The
allowedKindsfield has been deprecated. UsecatalogFilterinstead. This field allows users to specify a filter on the shape of EntityFilterQuery, which can be passed into the CatalogClient. See examples below:Get all entities of kind
GroupGet entities of kind
Groupand spec.typeteamb4955ed: - Deprecation - Deprecated the following exports, please import them directly from@backstage/plugin-scaffolder-reactinsteadDeprecation - Deprecated the
rootRouteRefexport, this should now be used fromscaffolderPlugin.routes.rootThe following
/alphatypes have removed from this package and moved to the@backstage/plugin-scaffolder-react/alphapackagePatch Changes
3c112f6: rollback@rjsf/validator-ajv8to@rjsf/validator-v62fadff2: Render the scaffolder action description using theMarkdownContentcomponent. This will allow the page to show richer content to describe scaffolder actions.27a5e90: Small updates to some paragraph components to ensure theme typography properties are inherited correctly.223e2c5: addonChangehandler toSteppercomponent659c92a: Updated dependencyuse-immerto^0.8.0.489935d: Show action example yaml on the scaffolder actions documentation page.b8269de: Explicitly declaring children as optional props to facilitate react 18 changesbackstage/backstage (@backstage/plugin-scaffolder-backend)
v1.22.11Compare Source
v1.22.10Compare Source
v1.22.9Compare Source
Patch Changes
78a0b08: Internal refactor to handleBackendFeaturecontract change.5c65785: Fixing issues with log redaction in the scaffolder logsd44a20a: Added additional plugin metadata topackage.json.7d30d95: Fixing issue with log meta fields possibly being circular refsd617103: Updating the logger redaction message to something less dramaticf4c8486: Increase max wait time in debug:wait action to 10 minutesbcec60f: added the following new permissions to the scaffolder backend endpoints:scaffolder.task.createscaffolder.task.cancelscaffolder.task.readUpdated dependencies
v1.22.8Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.f4c8486: Increase max wait time in debug:wait action to 10 minutesv1.22.7Compare Source
v1.22.6Compare Source
Patch Changes
131e5cb: Fix broken links in README.025641b: Fix issue with the log format not being respected when logging from actionsd229dc4: Move path utilities frombackend-commonto thebackend-plugin-apipackage.e4b50ab: Scaffolder workspace serialization025641b: Redactmetafields too with the loggerv1.22.5Compare Source
Patch Changes
v1.22.4Compare Source
Patch Changes
f34a9b1: Thecatalog:writeaction now automatically adds abackstage.io/template-sourceannotation, indicating which Scaffolder template was used to create the entity.v1.22.3Compare Source
Patch Changes
c74c2de: Fixed an issue causing actions to fail when retrieving auth credentialsv1.22.2Compare Source
Patch Changes
v1.22.1Compare Source
Patch Changes
v1.22.0Compare Source
Minor Changes
e9663a9: Move away from usingctx.logStreamaa543c9: Migrate plugin to use the new auth services, add an optional service discovery to the router options and change the permissions type to bePermissionsService.e9663a9: Enable the redaction of secrets using the redacting logger and the secrets from theTaskSpecc6b132e: Introducing checkpoints for scaffolder task action idempotencyPatch Changes
984abfa: Fixing the lost of the initial state after a task recovery.703ebc9: Fix support for unauthenticated requests to create scaffolder tasksf44589d: IntroducedcreateMockActionContextto unify the way of creating scaffolder mock context.It will help to maintain tests in a long run during structural changes of action context.
0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.bbd1fe1: Made "checkpoint" on scaffolder action context non-optionalUpdated dependencies
v1.21.3Compare Source
v1.21.2Compare Source
v1.21.1Compare Source
This release fixes the below issues:
getLocationByRefthat led to invalid backend calls with the Catalogv1.21.0Compare Source
Minor Changes
458bf21: Created a gitea module for the scaffolder. This module provides a new action "publish:gitea" able to create a gitea repository owned by an organization. See: https://gitea.com/api/swagger#/organization/createOrgRepo11b9a08: Introduced the first version of recoverable tasks.78c100b: Support providing an overriding token forfetch:template,fetch:plainandfetch:filewhen interacting with upstream integrationse9a5228: The built-in module list has been trimmed down when using the new Backend System. Provider specific modules should now be installed withbackend.addto provide additional actions to the scaffolder. These modules are as follows:@backstage/plugin-scaffolder-backend-module-github@backstage/plugin-scaffolder-backend-module-gitlab@backstage/plugin-scaffolder-backend-module-bitbucket@backstage/plugin-scaffolder-backend-module-gitea@backstage/plugin-scaffolder-backend-module-gerrit@backstage/plugin-scaffolder-backend-module-confluence-to-markdown@backstage/plugin-scaffolder-backend-module-cookiecutter@backstage/plugin-scaffolder-backend-module-rails@backstage/plugin-scaffolder-backend-module-sentry@backstage/plugin-scaffolder-backend-module-yeomanPatch Changes
5eb6882: New scaffolder module@backstage/plugin-scaffolder-backend-module-bitbucket-server.Extracted from
@backstage/plugin-scaffolder-backend-module-bitbucketand replaces its actions related to Bitbucket Server.
publish:bitbucketServerpublish:bitbucketServer:pull-request09f8b31: Simple typo fix in the fetch:template action example on the word 'skeleton'.c25a500: Fix some deprecations and misplacedawaitusage.f6792c6: Move theNODE_OPTIONSmessaging for--no-node-snapshotto theSecureTemplaterin order to get better messaging at runtime9aac2b0: Use--cwdas the firstyarnargument6bb6f3e: Updated dependencyfs-extrato^11.2.0.Updated dependency
@types/fs-extrato^11.0.0.52ae6b9: Updated dependencyesbuildto^0.20.0.5eb6882: New scaffolder module@backstage/plugin-scaffolder-backend-module-bitbucket-cloud.Extracted from
@backstage/plugin-scaffolder-backend-module-bitbucketand replaces its actions related to Bitbucket Cloud.
publish:bitbucketCloudbitbucket:pipelines:run0a395b3: Upgradedprom-clientto version 15e1c479d: When using node 20+ thescaffolder-backendwill now throw an error at startup if the--no-node-snapshotoption wasnot provided to node.
e0e5afe: Add option to configure nunjucks with thetrimBlocksandlstripBlocksoptions in the fetch:template actionUpdated dependencies
v1.20.0Compare Source
Minor Changes
a694f71: The Scaffolder builtin actions now contains an action for running pipelines from Bitbucket Cloud Rest API7c522c5: Addgitlab:repo:pushscaffolder action to push files to arbitrary branch without creating a Merge RequestPatch Changes
e9ab1c4: Fixed an issue where not passing avalueto any of the action's permission conditions caused an error.v1.19.2Compare Source
Patch Changes
219d7f0: Refactor some methods to-nodeinstead and use the new external modulesaff34fc: Fix issue with Circular JSON dependencies in templating48667b4: Fix creating env secret in github:environment:create action0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-592561728949ea: Add a new action for creating github-autolink references for a repository:github:autolinks:createv1.19.1Compare Source
This release fixes an issue where Microsoft auth would fail.
Contributed by @TheGemmell in https://github.com/backstage/backstage/pull/20655
v1.19.0Compare Source
Minor Changes
f3ab9cf: 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.7d5a921: Allow usingglobby'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.5e4127c: Allow settingupdate: trueinpublish:github:pull-requestscaffolder actionPatch Changes
0920fd0: Add examples forgithub:environment:createscaffolder action & improve related testsae30a9a: Added description for publish:gerrit scaffolder actions013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.23f72b2: Refactoring the runner to generate minimally informative task log per iteration and properly validate iterated actions.8613ba3: Switched to using"exports"field for/alphasubpath export.99d4936: Add examples forgithub:webhookscaffolder action & improve related tests2be3922: Add examples forgithub:deployKey:createscaffolder action & improve related tests76d07da: Make it possible to define control buttons text (Back, Create, Review) per templatef8727ad: Add examples forpublish:github:pull-requestscaffolder action & improve related testsv1.18.1Compare Source
This release fixes an issue in
@backstage/backend-test-utilswhere some existing versions of Jest would cause a type error becauseMockInstanceonly accepts two type arguments.v1.18.0Compare Source
Minor Changes
dea0aaf: Updatedpublish:gitlabaction properties to support additional Gitlab project settings:settingsproperty)branchesproperty)projectVariablesproperty)Marked existed properties
repoVisibilityandtopicsas deprecated, as they are covered bysettingsproperty.f41099b: Display meaningful error to the output if Gitlab namespace not found insidepublish:gitlab.Patch Changes
7dd82cc: Add examples forgithub:issues:labelscaffolder action & improve related tests733ddf7: Add examples forpublish:Azurescaffolder action.v1.17.3Compare Source
Patch Changes
v1.17.2Compare Source
This release fixes an issue where certain Gerrit integration setups were broken, and where it was not possible to query multiple facets from the catalog at the same time.
v1.17.1Compare Source
This release fixes an issue where the
EntitySwitchcomponent from@backstage/plugin-catalogwas preventing the display of entity errors. It also fixes the alphacatalogModuleTemplateKindexport from@backstage/plugin-scaffolder-backend, which had incorrect plugin and module IDs.v1.17.0Compare Source
Minor Changes
b5f239b: Improved theparseEntityRefScaffolder filter by introducing the ability for users to provide default kind and/or namespace values. The filter now takes2 arguments, similarly to the original parseEntityRef.
d5313ed: DEPRECATION: DeprecatedScaffolderEntitiesProcessor, which should now instead be imported from@backstage/plugin-catalog-backend-module-scaffolder-entity-model.catalogModuleTemplateKindwas also moved to that package and renamed tocatalogModuleScaffolderEntityModel, without any deprecation since it was an alpha export.Patch Changes
71114ac: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
a498955: Add examples forpublish:githubandpublish:gitlabscaffolder actions.ded27b8: Add examples forpublish:bitbucketscaffolder actions.5f1a92b: UseDefaultAzureDevOpsCredentialsProviderto retrieve credentials for Azure DevOps.fb57a46: Fixed the plugin and module ID of the alphacatalogModuleTemplateKindexport.f3c0b95: Add examples forgithub:actions:dispatchscaffolder actions.cfc3ca6: Changes needed to support MySQL814feee: Update to handle invalid luxon valuesUpdated dependencies
v1.16.5Compare Source
v1.16.4Compare Source
v1.16.3Compare Source
Patch Changes
a498955: Add examples forpublish:githubandpublish:gitlabscaffolder actions.5f1a92b: UseDefaultAzureDevOpsCredentialsProviderto retrieve credentials for Azure DevOps.fb57a46: Fixed the plugin and module ID of the alphacatalogModuleTemplateKindexport.cfc3ca6: Changes needed to support MySQLv1.16.2Compare Source
v1.16.1Compare Source
v1.16.0Compare Source
Minor Changes
e514aac: Introduceeachproperty on action steps, allowing them to be ran repeatedly.Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.config3496111: Removed the options from the alphascaffolderPluginexport. To extend the scaffolder plugin you instead now use the available extension points,scaffolderActionsExtensionPoint,scaffolderTaskBrokerExtensionPoint, andscaffolderTemplatingExtensionPoint.33c76ca: Added examples for thefs:deleteandfs:renameactionse07a491: Deprecated the following type exports, which have been moved to@backstage/plugin-scaffolder-nodeinstead:TemplateFilterTemplateGlobalTaskStatusTaskCompletionStateSerializedTaskTaskEventTypeSerializedTaskEventTaskBrokerDispatchResultTaskBrokerDispatchOptionsTaskContextTaskBroker0b1d775: Adds examples to a few scaffolder actions.88bc6e2: TheconcurrentTasksLimitoption can now be configured via static configuration as well. Setting it to 0 will now also disable the task worker.0f87332: Add examples forgithub:repo:createandgithub:repo:pushscaffolder actions.5c28ebc: Updated dependencyesbuildto^0.19.0.d3b31a7: DeprecatedexecuteShellCommand,RunCommandOptions, andfetchContentsfrom@backstage/plugin-scaffolder-backend, since they are useful for Scaffolder modules (who should not be importing from the plugin package itself). You should now import these from@backstage/plugin-scaffolder-backend-nodeinstead.RunCommandOptionswas renamed in the Node package asExecuteShellCommandOptions, for consistency.Updated dependencies
v1.15.1Compare Source
Patch Changes
600be80: Indicate the name of the option that is being deprecated in task deprecation warning.ff45cb5: Updated dependencyesbuildto^0.18.0.v1.15.0Compare Source
Minor Changes
84b0e47: AddTargetBranchNamevariable and output for thepublish:gitlab:merge-requestandpublish:github:pull-requests'cascaffolder actions.6a694ce: Add a scaffolder action that pull-requests for bitbucket server1948845: Addedgithub:deployKey:createandgithub:environment:createscaffolder actions. You will need to addread/writepermissions to your GITHUB_TOKEN and/or Github Backstage App for RepositoryAdministration(for deploy key functionality) andEnvironments(for Environment functionality)df84117: Add support for Repository Variables and Secrets to thepublish:githubandgithub:repo:createscaffolder actions. You will need to addread/writepermissions to your GITHUB_TOKEN and/or Github Backstage App for RepositorySecretsandVariablesUpgrade octokit introduces some breaking changes.
Patch Changes
cc936b5: Fix handling ofoptionalproperty incatalog:registerscaffolder actionb269da3: Clearer error messages for actionpublish:gitlab:merge-request11e0f62: Fix wrong gitlabUrl format in repoUrl input descriptiona2c70cd: Switch out the sandbox, fromvm2toisolated-vm.This is a native dependency, which means that it will need to be compiled with the same version of node on the same OS. This could cause some issues when running in Docker for instance, as you will need to make sure that the dependency is installed and compiled inside the docker container that it will run on.
This could mean adding in some dependencies to the container like
build-essentialto make sure that this compiles correctly.If you're having issues installing this dependency, there's some install instructions over on
isolated-vm's repo.Updated dependencies
v1.14.0Compare Source
Minor Changes
67115f5: Expose both types of scaffolder permissions and rules through the metadata endpoint.The metadata endpoint now correctly exposes both types of scaffolder permissions and rules (for both the template and action resource types) through the metadata endpoint.
a73b3c0: Add ability to usedefaultNamespaceanddefaultKindfor scaffolder actioncatalog:fetchPatch Changes
1a48b84: Bump minimum required version ofvm2to be 3.9.18d20c879: Bump minimum required version ofvm2to be 3.9.176d954de: Update typing forRouterOptions::actionsandScaffolderActionsExtensionPoint::addActionsto allow any kind of action being assigned to it.v1.13.1Compare Source
This release bumps the minimum required version of
vm2to 3.9.17v1.13.0Compare Source
Minor Changes
2b15cb4: The non-PR/MR Git Actions now return the commit hash of the commit pushed as a new output calledcommitHash, isomorphic-git is now on version 1.23.030ffdae: Addedfetch:plain:fileaction to fetch a single file, this action is also added to the list of built-in actions.65e989f: Added the possibility to authorize parameters and steps of a templateThe scaffolder plugin is now integrated with the permission framework.
It is possible to toggle parameters or actions within templates by marking each section with specific
tags, inside abackstage:permissionsproperty under each parameter or action. Each parameter or action can then be permissioned by using a conditional decision containing thescaffolderTemplateRules.hasTagrule.3b68b09: Renamed permissionApi router option to permissionsbcae5aa: Added the possibility to authorize actionsIt is now possible to decide who should be able to execute certain actions or who should be able to pass specific input to specified actions.
Some of the existing utility functions for creating conditional decisions have been renamed:
createScaffolderConditionalDecisionhas been renamed tocreateScaffolderActionConditionalDecisionscaffolderConditionshas been renamed toscaffolderTemplateConditionsd7c8c22: Allow for a commit message to differ from the PR title when publishing a GitHub pull request.95ea9f6: Provide some more default filters out of the box and refactoring how the filters are applied to theSecureTemplater.parseEntityRefwill take an string entity triplet and return a parsed object.pickwill allow you to reference a specific property in the piped object.So you can now combine things like this:
${{ parameters.entity | parseEntityRef | pick('name') }}to get the name of a specific entity, or${{ parameters.repoUrl | parseRepoUrl | pick('owner') }}to get the owner of a repo.Patch Changes
e23abb3: Rename output parametermergeRequestURLofpublish:gitlab:merge-requestaction tomergeRequestUrl.e27ddc3: Added a possibility to cancel the running task (executing of a scaffolder template)a7eb36c: Improve type-check for scaffolder output parametersc9a0fdc: Fix deprecated types.1e4f5e9: Bumpzodandzod-to-json-schemadependencies.9c26e6d: Updated the alphascaffolderPluginto not require options.f37a95a: Stripped entity types and namespace before passing to GitHub APIv1.12.0Compare Source
Minor Changes
7d724d8: Added the ability to be able to define an actionsinputandoutputschema usingzodinstead of hand writing types andjsonschemaPatch Changes
860de10: Make identity valid if subject of token is a backstage server-2-server auth token6545487: Minor API report tweaksc6c78b4: throw error from catalog:fetch scaffolder action when entity is null and optional is false9968f45: catalog write action should allow any shape of object928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.7af1285: Extended scaffolder actioncatalog:fetchto fetch multiple catalog entities by entity references.v1.11.0Compare Source
Minor Changes
0b2952e: Added the option to overwrite files in thetargetPathof thetemplate:fetchaction1271549: Renamed the exportscaffolderCatalogModuletocatalogModuleTemplateKindin order to follow the new recommended naming patterns of backend system items. This is technically a breaking change but in an alpha export, so take care to change your imports if you have already migrated to the new backend system.Patch Changes
0ff0331: Updated usage ofcreateBackendPlugin.ad3edc4: Deprecations: The following are deprecated and should instead be imported from the new package@backstage/plugin-scaffolder-node:ActionContextcreateTemplateActionTaskSecretsTemplateAction6c70919: Provide better error messaging when GitHub fails due to missing team definitions66cf22f: Updated dependencyesbuildto^0.17.0.Updated dependencies
v1.10.1Compare Source
@rjsf/*libraries were incompatiblev1.10.0Compare Source
Minor Changes
a6808b6: ImplementRequired approving review count,Restrictions, andRequired commit signingsupport forpublish:githubaction04a2048: Allow custom repository roles to be configured on github reposc0ad734: Add Scaffolder actioncatalog:fetchto get entity by entity reference from catalogb44eb68: This change adds changes to provide examples alongside scaffolder task actions.The
createTemplateActionfunction now takes a list of examples e.g.These examples can be retrieved later from the api.
72d6b9f: Added ability to override the commit message and author details for thepublish:bitbucketServeraction.a69664f: Add Github repository support for squash merge commit title and message optionsPatch Changes
2fadff2: Change scaffolder task actions to include markdown to demonstrate the newActionsPagemarkdown feature.ecbec4e: Internal refactor to match new options pattern in the experimental backend system.e4c0240: AddedcatalogFilterfield to OwnerPicker and EntityPicker components to support filtering options by any field(s) of an entity.The
allowedKindsfield has been deprecated. UsecatalogFilterinstead. This field allows users to specify a filter on the shape of EntityFilterQuery, which can be passed into the CatalogClient. See examples below:Get all entities of kind
GroupGet entities of kind
Groupand spec.typeteam8e06f3c: Switched imports ofloggerToWinstonLoggerto@backstage/backend-common.Updated dependencies
backstage/backstage (@backstage/plugin-search)
v1.4.13Compare Source
Patch Changes
v1.4.12Compare Source
Patch Changes
4f92394: Migrate from identityApi to fetchApi in frontend plugins.d44a20a: Added additional plugin metadata topackage.json.v1.4.11Compare Source
Patch Changes
0501243: Addedaria-labelattribute to DialogTitle element and setaria-modalattribute totruefor improved accessibility in the search modal.v1.4.10Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.backstage/backstage (@backstage/plugin-search-backend)
v1.5.13Compare Source
Patch Changes
v1.5.12Compare Source
v1.5.11Compare Source
v1.5.10Compare Source
Patch Changes
8869b8e: Updated local development setup.78a0b08: Internal refactor to handleBackendFeaturecontract change.d44a20a: Added additional plugin metadata topackage.json.5b6f979: Split backend search plugin startup into "init" and "start" stages to ensure necessary initialization has happened before startup34dc47d: Move @backstage/repo-tools to devDependenciesv1.5.9Compare Source
v1.5.8Compare Source
Patch Changes
c6cb568: Add lifecycle monitoring for the search index registryv1.5.7Compare Source
Patch Changes
2bd291e: Allow reserved characters in requests.d5a1fe1: Replaced winston logger withLoggerServicebackstage/backstage (@backstage/plugin-search-backend-module-pg)
v0.5.31Compare Source
Patch Changes
v0.5.30Compare Source
v0.5.29Compare Source
v0.5.28Compare Source
Patch Changes
78a0b08: Internal refactor to handleBackendFeaturecontract change.6a576dc: Replace the usage ofgetVoidLoggerwithmockServices.logger.mockin order to remove the dependency with the soon-to-be-deprecatedbackend-commonpackage.d44a20a: Added additional plugin metadata topackage.json.v0.5.27Compare Source
Patch Changes
d229dc4: Move path utilities frombackend-commonto thebackend-plugin-apipackage.v0.5.26Compare Source
Patch Changes
cf163a5: Enable module only on supported databasesAlso pass logger to the service
Updated dependencies
backstage/backstage (@backstage/plugin-search-backend-node)
v1.2.26Compare Source
Patch Changes
v1.2.25Compare Source
v1.2.24Compare Source
Patch Changes
6a576dc: Replace the usage ofgetVoidLoggerwithmockServices.logger.mockin order to remove the dependency with the soon-to-be-deprecatedbackend-commonpackage.d44a20a: Added additional plugin metadata topackage.json.5b6f979: Split backend search plugin startup into "init" and "start" stages to ensure necessary initialization has happened before startupv1.2.23Compare Source
v1.2.22Compare Source
Patch Changes
c6cb568: Add lifecycle monitoring for the search index registryv1.2.21Compare Source
Patch Changes
d5a1fe1: Replaced winston logger withLoggerServicebackstage/backstage (@backstage/plugin-search-react)
v1.7.12Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.v1.7.11Compare Source
Patch Changes
v1.7.10Compare Source
Patch Changes
8d50bd3: add mui imports eslint ruleabfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.backstage/backstage (@backstage/plugin-tech-radar)
v0.7.4Compare Source
v0.7.3Compare Source
backstage/backstage (@backstage/plugin-techdocs)
v1.10.6Compare Source
Patch Changes
654af4a: mkdocs-material have updated their CSS variable template, and a few are unset in Backstage. This patch adds the missing variables to ensure coverage.cbebad1: Internal updates to allow reusing Backstage'sfetchApiimplementation for event source requests. This allows you to for example, override theAuthorizationheader.96cd13e:TechDocsIndexPagenow accepts an optionalownerPickerModefor toggling the behavior of theEntityOwnerPicker, exposing a new mode<TechDocsIndexPage ownerPickerMode="all" />particularly suitable for larger catalogs. In this new mode,EntityOwnerPickerwill display all the users and groups present in the catalog.e40bd9a: Fixed bug inCopyToClipboardButtoncomponent where positioning of the "Copy to clipboard" button in techdocs code snippets was broken in some cases.d44a20a: Added additional plugin metadata topackage.json.1256d88: Fixed an issue preventing theTechDocsSearchBarcomponent from opening when clicking on the arrow icon.v1.10.5Compare Source
Patch Changes
d2cc139: Update path in Readme for Plugin Techdocs to show the correct setup information.5863cf7: Thetechdocs.builderconfig is now optional and it will default tolocal.v1.10.4Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.v1.10.3Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.10.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.10.1Compare Source
Patch Changes
7c2d022: Fixed bug in TechDocs sidebar render that prevented scrollbar from being displayed3f14e9f: Implement a client cookie refresh mechanism.62bcaf8: Use the new generic refresh user cookie provider.28f27f0: Added ESLint ruleno-top-level-material-ui-4-importsto aid with the migration to Material UI v5.v1.10.0Compare Source
Minor Changes
af4d147: Updated the styling for<code>tags to avoid word break.Patch Changes
912ca7b: UseconvertLegacyRouteRefsto define routes in/alphaexport plugin.8fe56a8: Widen@types/reactdependency range to include version 18.3631fb4: Updated dependencydompurifyto^3.0.0.Updated dependency
@types/dompurifyto^3.0.0.1cae748: Updated dependencygit-url-parseto^14.0.0.v1.9.3Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.9.2Compare Source
Patch Changes
03d0b6d: TheconvertLegacyRouteRefutility used by the alpha exports is now imported from@backstage/core-compat-api.a1227cc: Wrap/alphaexport extension elements in backwards compatibility wrapper.5814122: Updated/alphaexports to fit new naming patterns.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.v1.9.1Compare Source
This release fixes an issue where we accidentally released a change for
A11ythat meant that someSidebarItemswere being uppercased accidentally.v1.9.0Compare Source
Minor Changes
17f93d5: A new analytics eventnot-foundwill be published when a user visits a documentation site that does not existPatch Changes
4728b39: 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.a3add7a: Export alpha routes and nav item extension, only available for applications that uses the new Frontend system.71c97e7: The `spec.lifecycle' field in entities will now always be rendered as a string.68fc9dc: Updated alpha exports according to routing changes in@backstage/frontend-plugin-api.6c2b872: Add official support for React 18.0bf6ebd: Added entity page content for the new plugin exported via/alpha.67cc85b: Switched the conditionalreact-dom/clientimport to useimport(...)rather thanrequire(...).4aa43f6: Updated dependencycross-fetchto^4.0.0.38cda52: Added support for React 18. The newcreateRootAPI fromreact-dom/clientwill now be used if present.fdb5e23: ImportMissingAnnotationEmptyStatefrom@backstage/plugin-catalog-reactto remove the cyclical dependencyv1.8.0Compare Source
Minor Changes
27740ca: Added experimental support for declarative integration via the/alphasubpath.Patch Changes
4918f65: Create an experimentalTechDocsSearchResultItemExtensionfor declarative integration with Backstage; it can be accessed via the/alphaimport.3605370: ImprovedDocsTableto display pagination controls dynamically, appearing only when needed.0296f27: The `spec.lifecycle' field in entities will now always be rendered as a string.9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.9468a67: Added support for React 18. The newcreateRootAPI fromreact-dom/clientwill now be used if present.df449a7: Add kind column by default to TechDocsTablev1.7.0Compare Source
Minor Changes
e44f45a: This change allows a new annotation ofbackstage.io/techdocs-entitythis ref allows you to reference another entity for its TechDocs. This allows you have a single TechDoc for all items in a system, for example you might have a frontend and a backend in the same repo. This would allow you to have TechDocs build under aSystementity while referencing the system e.g.:backstage.io/techdocs-entity: system:default/examplethat will show the systems docs in both the TechDocs button and the TechDocs tab without needing to do duplicate builds and filling the TechDocs page with garbage.Patch Changes
88c9525: Fixed bug in styles that caused next and previous links in footer to overlap page content.406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.6.8Compare Source
Patch Changes
88c9525: Fixed bug in styles that caused next and previous links in footer to overlap page content.v1.6.7Compare Source
v1.6.6Compare Source
Patch Changes
v1.6.5Compare Source
Patch Changes
v1.6.4Compare Source
Patch Changes
2f660eb: Fix SearchBar styles & update StoryBook stories for custom styles fornotchedOutlineclass.956d09e: Change deprecated local references to import from sharedplugin-techdocs-reactplugine33beb1: Make the documentation pages printable (also handy for exporting to PDF)v1.6.3Compare Source
Patch Changes
v1.6.2Compare Source
Patch Changes
863beb4: Re-add the possibility to have trailing slashes in Techdocs navigation.v1.6.1Compare Source
Patch Changes
6c809d1: Minor visual tweaks to adapt to changes in mkdocs-material v9b2e182c: Fixes a UI bug in search result item which rendered the item text with incorrect font size and color847a1ee: Change anchor links color in Techdocs contentWith the color (mkdocs supplied) used for anchor links the background and foreground colors do not have a sufficient contrast ratio. Using the link color from theme palette.
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)2e49348: Fix a bug in sub-path navigation due to double addition of a sub-path if one was set up inapp.baseUrl.e0c6e8b: Update peer dependenciesUpdated dependencies
v1.6.0Compare Source
Minor Changes
3f75b76: Add ability to pass icon as function to have ability to customize it by search itemPatch Changes
6545487: Minor API report tweaks54a1e13: Fix bug that caused next and previous links not to work with certain versions of mkdocs-materialf320c29: The HTML tag attributes in the documentation content inserted to shadow DOM is preserved to improve accessibilitycb8ec97: Change black & white colors to be theme awarec10384a: Switch to usingLinkButtoninstead of the deprecatedButton8adfda6: Updated dependencyjssto~10.10.0.52b0022: Updated dependencymswto^1.0.0.238cf65: Copy to clipboard now works in a not secure context.v1.5.0Compare Source
Minor Changes
20840b3: Update DocsTable and EntityListDocsTable to accept overrides for Material Table options.0eaa579: TheTechDocsSearchResultListItemcomponent is now a search result extension. This means that when rendered as a child of components that render search extensions, theresult,rank, andhighlightproperties are optional. See the documentation for more details.Patch Changes
c8e09cc: Fixed bug in Techdocs reader where a techdocs page with a hash in the URL did not always jump to the document anchor.cad5607: Improve view: remove footer overlay on large screen66e2aab:ListItemwrapper component moved toSearchResultListItemExtensionfor all*SearchResultListItemsthat are exported as extensions. This is to make sure the list only contains list elements.Note: If you have implemented a custom result list item, we recommend you to remove the list item wrapper to avoid nested
<li>elements.4660b63: Create a TechDocs<LightBox/>addon that allows users to open images in a light-box on documentation pages, they can navigate between images if there are several on one page.Here's an example on how to use it in a Backstage app:
Updated dependencies
v1.4.3Compare Source
Patch Changes
a74dd61: Fix sizing of build log component to render all lines80ce4e8: Small updates to some components to ensure theme typography properties are inherited correctly.7115c73: Updated dependencyjssto~10.9.0.backstage/backstage (@backstage/plugin-techdocs-backend)
v1.10.8Compare Source
Patch Changes
v1.10.7Compare Source
v1.10.6Compare Source
Patch Changes
e64bfb2: Allow defining custom build log transport for techdocs builder8869b8e: Updated local development setup.78a0b08: Internal refactor to handleBackendFeaturecontract change.2110d76: Removeddockerodedependency.d44a20a: Added additional plugin metadata topackage.json.v1.10.5Compare Source
Patch Changes
5863cf7: Thetechdocs.builderconfig is now optional and it will default tolocal.v1.10.4Compare Source
Patch Changes
8e28c88: Allow overriding default techdocs preparers with newTechdocsPreparerExtensionPointc884b9a: Use the default cookie endpoints added automatically when a cookie policy is set.v1.10.3Compare Source
Patch Changes
v1.10.2Compare Source
Patch Changes
v1.10.1Compare Source
Patch Changes
v1.10.0Compare Source
Minor Changes
718b734: Create extension pointTechdocsGeneratorExtensionPointto allow adding a custom generatorPatch Changes
3f14e9f: Migrate plugin to use the new auth services.v1.9.6Compare Source
Patch Changes
v1.9.5Compare Source
v1.9.4Compare Source
v1.9.3Compare Source
Patch Changes
6bb6f3e: Updated dependencyfs-extrato^11.2.0.Updated dependency
@types/fs-extrato^11.0.0.d2e3ab9: Updated dependencydockerodeto^4.0.0.v1.9.2Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.9.1Compare Source
Patch Changes
a402644: Regenerates a fresh token for each call to the search index when collating techdocs.v1.9.0Compare Source
Minor Changes
67cff7b: Expose an extension point to set a custom build strategy. Also moveDocsBuildStrategytype to@backstage/plugin-techdocs-nodeand deprecateShouldBuildParameterstype.Patch Changes
c3c5c7e: Add info about the entity when tech docs fail to build48a61bf: Fix potential memory leak by not creating a build log transport if not given viaRouterOptions.013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.v1.8.0Compare Source
Minor Changes
344cfbc: Allow prepared directory clean up for custom preparersWhen using custom preparer for TechDocs, the
preparedDirmightend up taking disk space. This requires all custom preparers to
implement a new method
shouldCleanPreparedDirectorywhich indicateswhether the prepared directory should be cleaned after generation.
Patch Changes
v1.7.2Compare Source
Patch Changes
v1.7.1Compare Source
This release fixes an issue where
@backstage/create-appunintentionally required Git to be set up for it to be able to create a new project.v1.7.0Compare Source
Minor Changes
5985d45: Add atechdocs.publisher.azureBlobStorage.connectionStringapp-config setting, which can be leveraged for improved Azurite support.10a86bd: Add optional config and cli option for techdocs to specify default mkdocs plugins.Patch Changes
60af801: Expand techdocs.publisher.type withgoogleGcs,awsS3,azureBlobStorageandopenStackSwift71114ac: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
a8a614b: Minorpackage.jsonupdate.Updated dependencies
v1.6.7Compare Source
Patch Changes
v1.6.6Compare Source
v1.6.5Compare Source
Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.configv1.6.4Compare Source
Patch Changes
v1.6.3Compare Source
Patch Changes
v1.6.2Compare Source
Patch Changes
v1.6.1Compare Source
Patch Changes
01ae205: Collator factories instantiated in new backend system modules and now marked as deprecated. Will be continued to be exported publicly until the new backend system is fully rolled out.v1.6.0Compare Source
Minor Changes
92b4953: Introduced alpha export of thetechdocsPluginusing the new backend system.Patch Changes
40298b0: Techdocs backend explains a bit more about what might have caused the docs not being found when building techdocs.928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.v1.5.3Compare Source
Patch Changes
6f09702: Keep the tech docs sync event stream alive even if it is taking a while to build.339d9a5: Added support for using a defaultmkdocs.ymlconfiguration file when none is providedv1.5.2Compare Source
v1.5.1Compare Source
Patch Changes
backstage/backstage (@backstage/plugin-techdocs-module-addons-contrib)
v1.1.11Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.v1.1.10Compare Source
Patch Changes
v1.1.9Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.v1.1.8Compare Source
Patch Changes
v1.1.7Compare Source
Patch Changes
v1.1.6Compare Source
Patch Changes
v1.1.5Compare Source
Patch Changes
ab9c9eb: Fixed the value label text color in dark mode for the TextSize addon.09cedb9: Updated dependency@react-hookz/webto^24.0.0.1cae748: Updated dependencygit-url-parseto^14.0.0.131ffdc: Fix position of the ReportIssue component when is displaying at the top of the container.v1.1.4Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.1.3Compare Source
Patch Changes
a518c5a: Updated dependency@react-hookz/webto^23.0.0.v1.1.2Compare Source
Patch Changes
4728b39: 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.6c2b872: Add official support for React 18.62b5922: Internal theme type updatesv1.1.1Compare Source
Patch Changes
v1.1.0Compare Source
Minor Changes
86c1990: Enable zoom icon for techdocs images inside lightboxPatch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.0.18Compare Source
Patch Changes
v1.0.17Compare Source
v1.0.16Compare Source
Patch Changes
v1.0.15Compare Source
Patch Changes
v1.0.14Compare Source
Patch Changes
v1.0.13Compare Source
Patch Changes
6afc7f0: Show cursor pointer when hovering on lightboxv1.0.12Compare Source
Patch Changes
c657d0a: Bumpphotoswipedependency to^5.3.7.8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv1.0.11Compare Source
Patch Changes
52b0022: Updated dependencymswto^1.0.0.37cf85f: Fixed bug in IssueLink component where the URL was not generated properly when the repository was located inside a Gitlab subgroupv1.0.10Compare Source
Patch Changes
d950d3e: Depend on@material-ui/coreversion^4.12.2like all other in-repo packages4660b63: Create a TechDocs<LightBox/>addon that allows users to open images in a light-box on documentation pages, they can navigate between images if there are several on one page.Here's an example on how to use it in a Backstage app:
Updated dependencies
v1.0.9Compare Source
Patch Changes
backstage/backstage (@backstage/plugin-techdocs-react)
v1.2.5Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.v1.2.4Compare Source
Patch Changes
v1.2.3Compare Source
Patch Changes
b450af3: Added ESLint ruleno-top-level-material-ui-4-importsin the Techdocs-react plugin to migrate the Material UI imports.abfbcfc: Updated dependency@testing-library/reactto^15.0.0.v1.2.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.2.1Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.2.0Compare Source
Minor Changes
3f14e9f: Create a new api method for issuing user cookie.Patch Changes
v1.1.16Compare Source
Patch Changes
9aac2b0: Use--cwdas the firstyarnargument8fe56a8: Widen@types/reactdependency range to include version 18.v1.1.15Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.1.14Compare Source
Patch Changes
v1.1.13Compare Source
Patch Changes
6c2b872: Add official support for React 18.v1.1.12Compare Source
Patch Changes
9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.v1.1.11Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v1.1.10Compare Source
Skipped due to publishing issues.
v1.1.9Compare Source
Patch Changes
v1.1.8Compare Source
Patch Changes
v1.1.7Compare Source
Patch Changes
3d11596: Update plugin installation docs to be more consistent across documentationsv1.1.6Compare Source
Patch Changes
v1.1.5Compare Source
Patch Changes
7e0c7b0: Fix a bug that caused the header to not render when generating a document for the first time8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv1.1.4Compare Source
Patch Changes
6545487: Minor API report tweaks928a12a: Internal refactor of/alphaexports.8adfda6: Updated dependencyjssto~10.10.0.v1.1.3Compare Source
Patch Changes
v1.1.2Compare Source
Patch Changes
7115c73: Updated dependencyjssto~10.9.0.b8269de: Explicitly declaring children as optional props to facilitate react 18 changesbackstage/backstage (@backstage/plugin-user-settings)
v0.8.8Compare Source
Patch Changes
v0.8.7Compare Source
Patch Changes
d44a20a: Added additional plugin metadata topackage.json.e6ec179: Use signals to update user settings across sessionsv0.8.6Compare Source
Patch Changes
131e5cb: Fix broken links in README.v0.8.5Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.cb1e3b0: Updated dependency@testing-library/domto^10.0.0.backstage/backstage (@backstage/test-utils)
v1.5.7Compare Source
Patch Changes
v1.5.6Compare Source
Patch Changes
v1.5.5Compare Source
Patch Changes
v1.5.4Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.v1.5.3Compare Source
Patch Changes
v1.5.2Compare Source
Patch Changes
v1.5.1Compare Source
Patch Changes
v1.5.0Compare Source
Minor Changes
bb40898: Addedcomponentsoption toTestAppOptions, which will be forwarded as thecomponentsoption tocreateApp.Patch Changes
07e7d12: Fix wording in API reference8fe56a8: Widen@types/reactdependency range to include version 18.7da67ce: ChangedefaultScopesfor Bitbucket auth from invalidteamtoaccount.v1.4.7Compare Source
Patch Changes
v1.4.6Compare Source
Patch Changes
e8f2ace: DeprecatedmockBreakpoint, as it is now available from@backstage/core-components/testUtilsinstead.v1.4.5Compare Source
Patch Changes
6c2b872: Add official support for React 18.4aa43f6: Updated dependencycross-fetchto^4.0.0.v1.4.4Compare Source
Patch Changes
322bbca: Removed the alphaMockPluginProviderexport since the plugin configuration API has been removed.1a0616f: Add missing resource and template app icons9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.v1.4.3Compare Source
Patch Changes
7032c21: Add pod exec terminal to Container Card406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyb5fbddc: Add a newMockTranslationApias an/alphaexport.9ceb619: Add support for React Testing Library 13+, and thus React 18.We're exposing an additional option to the
render*methods to enable thelegacyRootflow.Updated dependencies
v1.4.2Compare Source
Patch Changes
v1.4.1Compare Source
Patch Changes
8174cf4: Fixing MUI / Material UI referencesv1.4.0Compare Source
Minor Changes
1fd38bc: Test App Wrapper is now usingUnifiedThemeProviderfor supporting Material UI v5 next to Material UI v4 in tests.Patch Changes
55853a3: Add afetchApiRefimplementation by defaultv1.3.1Compare Source
Patch Changes
v1.3.0Compare Source
Minor Changes
7908d72: Introduce a new global config parameter,enableExperimentalRedirectFlow. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.Patch Changes
e0c6e8b: Update peer dependenciesv1.2.6Compare Source
Patch Changes
928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.482dae5: Updated link to docs.v1.2.5Compare Source
Patch Changes
v1.2.4Compare Source
Patch Changes
backstage/backstage (@backstage/theme)
v0.5.6Compare Source
Patch Changes
702fa7d: Internal refactor to fix an issue where the MUI 5v5-class prefixing gets removed by tree shaking.v0.5.5Compare Source
v0.5.4Compare Source
Patch Changes
f1462df: Fixed bug where scrollbars don't pick up the theme when in dark modev0.5.3Compare Source
Patch Changes
abfbcfc: Updated dependency@testing-library/reactto^15.0.0.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Renovate Bot.
5e31b5c594to7cb1aacc507cb1aacc50to06a2547532