chore: Update dependency @backstage/backend-defaults to v0.7.0 #91
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.4.1
->0.7.0
Release Notes
backstage/backstage (@backstage/backend-defaults)
v0.7.0
Compare Source
Minor Changes
ec547b8
: Ensure that an error handler middleware exists at the end of each pluginhttpRouter
handler chain. This makes it so that exceptions thrown by plugin routes are caught and encoded in the standard error format.If you were using the standard
MiddlewareFactory
just to put anerror
middleware in you router, you can now remove that at your earliest convenience since it's redundant. If you have custom error handlers in your plugin router, those will continue to function as previously. If you were relying on thrown errors propagating all the way down to the root HTTP router, you will find that they no longer do that, and may want to hoist your error handling up to the plugin level instead.Patch Changes
575613f
: Go back to usingnode-fetch
for gitlabd2b16db
: TheGerritUrlReader
can now read content from a commit and not only from the top of a branch. TheGitiles URL must contain the full commit
SHA
hash like:https://gerrit.com/gitiles/repo/+/2846e8dc327ae2f60249983b1c3b96f42f205bae/catalog-info.yaml
.8ecf8cb
: Exclude@backstage/backend-common
from schema collection if@backstage/backend-defaults
is present8379bf4
: Remove usages ofPluginDatabaseManager
andPluginEndpointDiscovery
and replace with their equivalent service typesv0.6.2
Compare Source
v0.6.1
Compare Source
v0.6.0
Compare Source
Minor Changes
fd5d337
: Added a newbackend.health.headers
configuration that can be used to set additional headers to include in health check responses.BREAKING CONSUMERS: As part of this change the
createHealthRouter
function exported from@backstage/backend-defaults/rootHttpRouter
now requires the root config service to be passed through theconfig
option.3f34ea9
: Throttles Bitbucket Server API callsde6f280
: BREAKING Upgraded @keyv/redis and keyv packages to resolve a bug related to incorrect resolution of cache keys.This is a breaking change for clients using the
redis
store for cache withuseRedisSets
option set to false since cache keys will be calculated differently (without the sets:namespace: prefix). For clients with default configuration (or useRedisSets set to false) the cache keys will stay the same, but since @keyv/redis library no longer supports redis sets they won't be utilised anymore.If you were using
useRedisSets
option in configuration make sure to remove it fromapp-config.yaml
:29180ec
: BREAKING PRODUCERS: TheLifecycleMiddlewareOptions.startupRequestPauseTimeout
has been removed. Use thebackend.lifecycle.startupRequestPauseTimeout
setting in yourapp-config.yaml
file to customize how thecreateLifecycleMiddleware
function should behave. Also the root config service is required as an option when calling thecreateLifecycleMiddleware
function:277092a
: ImplementedAzureBlobStorageUrlReader
to read from the url of committed location from the entity provider18a2c00
: All middleware used by the defaultcoreServices.http
is now exported for use by custom implementations.Patch Changes
dfc8b41
: Updated dependency@opentelemetry/api
to^1.9.0
.5b1e68c
: Immediately close all connections when shutting down in local development.8863b38
: ExportPluginTokenHandler
andpluginTokenHandlerDecoratorServiceRef
to allow for custom decoration of the plugin token handler without having to re-implement the entire handler.29180ec
: Fix server response time by moving the lifecycle startup hooks back to the plugin lifecycle service.57e0b11
: The user and plugin token verification in the defaultAuthService
implementation will no longer forward verification errors to the caller, and instead log them as warnings.97c6837
: ExportDefaultHttpAuthService
to allow for custom token extraction logic.e5255f1
: Log request and response metadata so it can be used for filtering log messages.The format of the request date was also changed from
clf
toutc
.57e0b11
: The defaultauthServiceFactory
now correctly depends on the plugin scopedLogger
services rather than the root scoped one.fe87fbf
: Add task metrics as two gauges that track the last start and end timestamps as epoch seconds.1ac6b72
: Supportconnection.type: cloudsql
in database client for usage with@google-cloud/cloud-sql-connector
andiam
auth0e9c9fa
: Implements theDefaultRootLifecycleService.addBeforeShutdownHook
method, and updatesDefaultRootHttpRouterService
andDefaultRootHealthService
to listen to that event to stop accepting traffic and close service connections.d0cbd82
: Remove use of thestoppable
library on theDefaultRootHttpRouterService
as Node's native http server close method already drains requests.5c9cc05
: Use native fetch instead of node-fetchcf627c6
: Fixed an issue in the WinstonLogger where Errors thrown and given to logger.error with field values that could not be cast to a string would throw a TypeErrorv0.5.3
Compare Source
Patch Changes
bf306cb
: Removed dependency@backstage/backend-common
.e30bb46
: Disabling database migrations now correctly uses thebackend.default.skipMigrations
config value.d52d7f9
: Support ISO and ms string forms of durations in config toof6eaec2
: Link to proper package inrootLoggerServiceFactory
doc string.ecf6b39
: Usenode-fetch
instead of native fetch, as per https://backstage.io/docs/architecture-decisions/adrs-adr0134e58bc7
: Upgrade to uuid v11 internallyv0.5.2
Compare Source
v0.5.1
Compare Source
Patch Changes
4b60e0c
: Small tweaks to API reports to make them valid321a994
: Sensitive internal fields onBackstageCredentials
objects are now defined as read-only properties in order to minimize risk of leakage.ffd1f4a
: Plugin lifecycle shutdown hooks are now performed before root lifecycle shutdown hooks.ffd1f4a
: The database manager now attempts to close any database connections in a root lifecycle shutdown hook.e36d12f
: The task scheduler now attempts to abort any tasks if it detects that Backstage is being shut down.fd6e6f4
: build(deps): bumpcookie
from 0.6.0 to 0.7.0094eaa3
: Remove references to in-repo backend-common720a2f9
: Updated dependencygit-url-parse
to^15.0.0
.920004b
: Updating error message for getProjectId when fetching Gitlab project from its url to be more accurated7b44f0
: Fix for backend shutdown hanging during local development due to SQLite connection shutdown never resolving.8fd7deb
: The default root HTTP service implementation will now pretty-print JSON responses in development.If you are overriding the
rootHttpRouterServiceFactory
with aconfigure
function that doesn't callapplyDefaults
, you can introduce this functionality by adding the following snippet insideconfigure
:Updated dependencies
v0.5.0
Compare Source
Minor Changes
a4bac3c
: BREAKING: You can no longer supply abasePath
option to the host discovery implementation. In the new backend system, the ability to choose this path has been removed anyway at the plugin router level.359fcd7
: BREAKING: The backwards compatibility with plugins using legacy auth through the token manager service has been removed. This means that instead of falling back to using the old token manager, requests towards plugins that don't support the new auth system will simply fail. Please make sure that all plugins in your deployment are hosted within a backend instance from the new backend system.baeef13
: BREAKING RemovedcreateLifecycleMiddleware
andLifecycleMiddlewareOptions
to clean up API surface. These exports have no external usage and do not provide value in its current form. If you were using these exports, please reach out to the maintainers to discuss your use case.d425fc4
: BREAKING: The return values fromcreateBackendPlugin
,createBackendModule
, andcreateServiceFactory
are now simplyBackendFeature
andServiceFactory
, instead of the previously deprecated form of a function that returns them. For this reason,createServiceFactory
also no longer accepts the callback form where you provide direct options to the service. This also affects allcoreServices.*
service refs.This may in particular affect tests; if you were effectively doing
createBackendModule({...})()
(note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in yourpackages/backend/src/index.ts
too, where you add plugins, modules, and services. If you were usingcreateServiceFactory
with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.As part of this change, the
IdentityFactoryOptions
type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to migrate to the new auth system if you still rely on it.19ff127
: BREAKING: The default backend instance no longer provides implementations for the identity and token manager services, which have been removed from@backstage/backend-plugin-api
.If you rely on plugins that still require these services, you can add them to your own backend by re-creating the service reference and factory.
The following can be used to implement the identity service:
The following can be used to implement the token manager service:
055b75b
: BREAKING: Simplifications and cleanup as part of the Backend System 1.0 work.For the
/database
subpath exports:dropDatabase
function has now been removed, without replacement.LegacyRootDatabaseService
type has now been removed.DatabaseManager.forPlugin
is now directly aDatabaseService
, as arguably expected.DatabaseManager.forPlugin
now requires thedeps
argument, with the logger and lifecycle services.For the
/cache
subpath exports:PluginCacheManager
type has been removed. You can still import it from@backstage/backend-common
, but it's deprecated there, and you should move off of that package by migrating fully to the new backend system.CacheManager.forPlugin
immediately returns aCacheService
instead of aPluginCacheManager
. The outcome of this is that you no longer need to make the extra.getClient()
call. The oldCacheManager
with the old behavior still exists on@backstage/backend-common
, but the above recommendations apply.Patch Changes
213664e
: Fixed an issue where theuseRedisSets
configuration for the cache service would have no effect.6ed9264
: chore(deps): bumppath-to-regexp
from 6.2.2 to 8.0.0622360e
: Move down the discovery config to be in the root7f779c7
:auth.externalAccess
should be optional in the config schemafe6fd8c
: AcceptConfigService
instead ofConfig
in constructors/factories82539fe
: Updated dependencyarchiver
to^7.0.0
.c2b63ab
: Updated dependencysupertest
to^7.0.0
.5705424
: Wrap scheduled tasks from the scheduler core service now in OpenTelemetry spans7a72ec8
: Exports thediscoveryFeatureLoader
as a replacement for the deprecatedfeatureDiscoveryService
.The
discoveryFeatureLoader
is a new backend system feature loader that discovers backend features from the currentpackage.json
and its dependencies.Here is an example using the
discoveryFeatureLoader
loader in a new backend instance:b2a329d
: Properly indent the config schema66dbf0a
: Allow the cache service to accept the human duration format for TTL5a8fcb4
: Added the option to skip database migrations by settingskipMigrations: true
in config. This can be done globally in the database config or by plugin id.0b2a402
: Updates to the config schema to match realityUpdated dependencies
v0.4.4
Compare Source
@backstage/backend-common@0.4.2
Patch Changes
5ecd50f
: Fix HTTPS certificate generation and add new config switch, enabling it simply by settingbackend.https = true
. Also introduces caching of generated certificates in order to avoid having to add a browser override every time the backend is restarted.00042e7
: Moving the Git actions to isomorphic-git instead of the node binding version of nodegit0829ff1
: Tweaked development log formatter to include extra fields at the end of each log line036a843
: Provide support for on-prem azure devopsad5c56f
]036a843
]@backstage/cli@0.4.5
Patch Changes
37a7d26
: Use consistent file extensions for JS output when building packages.818d45e
: Fix detection of external package child directories0588be0
: Addbackend:bundle
command for bundling a backend package with dependencies into a deployment archive.b8abdda
: Add color to output fromversions:bump
in order to make it easier to spot changes. Also highlight possible breaking changes and link to changelogs.ad5c56f
]@backstage/config-loader@0.4.1
Patch Changes
ad5c56f
: Deprecate$data
and replace it with$include
which allows for any type of json value to be read from external files. In addition,$include
can be used without a path, which causes the value at the root of the file to be loaded.Most usages of
$data
can be directly replaced with$include
, except if the referenced value is not a string, in which case the value needs to be changed. For example:app-config.yaml
foo.yaml
bar.yaml
@backstage/core-api@0.2.9
Patch Changes
ab08923
: Remove test dependencies from production package list@backstage/create-app@0.3.2
Patch Changes
c2b52d9
: Replaceregister-component
plugin with newcatalog-import
pluginfc6839f
: Bumpsqlite3
to v5.To apply this change to an existing app, change the version of
sqlite3
in thedependencies
ofpackages/backend/package.json
:Note that the
sqlite3
dependency may not be preset if you chose to use PostgreSQL when creating the app.8d68e4c
: Removed the Circle CI sidebar item, since the target page does not exist.To apply this change to an existing app, remove
"CircleCI"
sidebar item frompackages/app/src/sidebar.tsx
, and theBuildIcon
import if it is unused.1773a51
: Removed lighthouse plugin from the default set up plugins, as it requires a separate Backend to function.To apply this change to an existing app, remove the following:
lighthouse
block fromapp-config.yaml
.@backstage/plugin-lighthouse
dependency frompackages/app/package.json
.@backstage/plugin-lighthouse
re-export frompackages/app/src/plugins.ts
.packages/app/src/sidebar.tsx
, and theRuleIcon
import if it is unused.@backstage/integration@0.1.5
Patch Changes
036a843
: Provide support for on-prem azure devops@backstage/techdocs-common@0.3.2
Patch Changes
7ec5254
: 1. Added option to use AWS S3 as a choice to store the static generated files for TechDocs.f8ba88d
: Fix forintegration.github.apiBaseUrl
configuration not properly overriding apiBaseUrl used by techdocs00042e7
: Moving the Git actions to isomorphic-git instead of the node binding version of nodegit5ecd50f
]00042e7
]0829ff1
]036a843
]@backstage/plugin-auth-backend@0.2.9
Patch Changes
0289a05
: Add support for the majority of the Core configurations for Passport-SAML.These configuration keys are supported:
As part of this change, there is also a fix to the redirection behaviour when doing load balancing and HTTPS termination - the application's baseUrl is used to generate the callback URL. For properly configured Backstage installations, no changes are necessary, and the baseUrl is respected.
Updated dependencies [
5ecd50f
]Updated dependencies [
00042e7
]Updated dependencies [
0829ff1
]Updated dependencies [
036a843
]@backstage/plugin-catalog@0.2.10
Patch Changes
9c09a36
: Remove the unused dependency to@backstage/plugin-techdocs
.8e083f4
]947d3c2
]@backstage/plugin-catalog-backend@0.5.2
Patch Changes
99be305
: Fixed a bug where the catalog would read back all entities when adding a location that already exists.49d2016
: Changelocation_update_log
columns fromnvarchar(255)
totext
73e75ea
: Add processor for ingesting AWS accounts from AWS Organizations071711d
: Removesqlite3
as a dependency. You may need to addsqlite3
as a dependency of your backend if you were relying on this indirect dependency.5ecd50f
]00042e7
]0829ff1
]036a843
]@backstage/plugin-catalog-import@0.3.3
Patch Changes
edb7d07
: Create "url" type location when registering using the catalog-import plugin.99be305
]49d2016
]9c09a36
]73e75ea
]036a843
]071711d
]@backstage/plugin-cost-insights@0.5.5
Patch Changes
ab08923
: Remove test dependencies from production package list@backstage/plugin-pagerduty@0.2.5
Patch Changes
b7a1248
: Optimize empty state image size.@backstage/plugin-rollbar-backend@0.1.6
Patch Changes
dde4ab3
: Bumpaxios
from^0.20.0
to^0.21.1
.5ecd50f
]00042e7
]0829ff1
]036a843
]@backstage/plugin-scaffolder@0.3.6
Patch Changes
8e083f4
: Bug fix: User can retry creating a new component if an error occurs, without having to reload the page.947d3c2
: You can now maximize the logs into full-screen by clicking the button under each step of the job9c09a36
]@backstage/plugin-scaffolder-backend@0.3.7
Patch Changes
37a5244
: Add scaffolding support for Bitbucket Cloud and Server.00042e7
: Moving the Git actions to isomorphic-git instead of the node binding version of nodegit9efbc55
: Add config schema for Bitbucket scaffolder5ecd50f
]00042e7
]0829ff1
]036a843
]@backstage/plugin-search@0.2.5
Patch Changes
0170743
: Fix Material-UI warning for search filtering9c09a36
]@backstage/plugin-sentry@0.3.2
Patch Changes
88da267
: Port to new composability API by exporting newEntitySentryContent
andEntitySentryCard
component extensions.9c09a36
]@backstage/plugin-tech-radar@0.3.2
Patch Changes
ab08923
: Remove test dependencies from production package listbc90917
: Updated example data inREADME
.@backstage/plugin-techdocs-backend@0.5.2
Patch Changes
7ec5254
: 1. Added option to use AWS S3 as a choice to store the static generated files for TechDocs.7ec5254
]5ecd50f
]f8ba88d
]00042e7
]0829ff1
]036a843
][email protected]
Patch Changes
ab08923
]37a7d26
]8e083f4
]88da267
]9c09a36
]0170743
]edb7d07
]818d45e
]0588be0
]b8abdda
]b7a1248
]bc90917
]947d3c2
]v0.4.3
Compare Source
@backstage/cli@0.4.4
Patch Changes
d45efbc
: Fix typo in .app.listen.port config schema@backstage/core@0.4.3
Patch Changes
a08c32c
: AddFlatRoutes
component to replace the top-levelRoutes
component fromreact-router
within apps, removing the need for manually appending/*
to paths or sorting routes.a08c32c
]86c3c65
]27f2af9
]@backstage/core-api@0.2.8
Patch Changes
a08c32c
: AddFlatRoutes
component to replace the top-levelRoutes
component fromreact-router
within apps, removing the need for manually appending/*
to paths or sorting routes.86c3c65
: DeprecateRouteRef
path parameter and member, and remove deprecatedrouteRef.createSubRouteRef
.27f2af9
: Delay auth loginPopup close to avoid race condition with callers of authFlowHelpers.@backstage/create-app@0.3.1
Patch Changes
4e0e3b1
: Add missingyarn clean
for app.For users with existing Backstage installations, add the following under the
scripts
section inpackages/app/package.json
, after the "lint" entry:This will add the missing
yarn clean
for the generated frontend.352a658
: Added"start-backend"
script to rootpackage.json
.To apply this change to an existing app, add the following script to the root
package.json
:@backstage/dev-utils@0.1.7
Patch Changes
696b8ce
: Add newaddPage
method for use with extensions, as well as anEntityGridItem
to easily create different test cases for entity overview cards.a08c32c
]7e0b8ca
]87c0c53
]@backstage/techdocs-common@0.3.1
Patch Changes
8804e89
: Using @backstage/integration package for GitHub/GitLab/Azure tokens and request options.Most probably you do not have to make any changes in the app because of this change.
However, if you are using the
DirectoryPreparer
orCommonGitPreparer
exported by@backstage/techdocs-common
package, you now need to add pass in aconfig
(from@backstage/config
)instance as argument.
@backstage/plugin-api-docs@0.4.2
Patch Changes
9161531
: Link register API to catalog-import plugina08c32c
]7e0b8ca
]87c0c53
]Configuration
📅 Schedule: Branch creation - "* 0-4,22-23 * * 1-5,* * * * 0,6" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.