Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update dependency @backstage/backend-defaults to v0.7.0 #91

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 20, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@backstage/backend-defaults (source) 0.4.1 -> 0.7.0 age adoption passing confidence

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 plugin httpRouter 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 an error 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

v0.6.2

Compare Source

v0.6.1

Compare Source

v0.6.0

Compare Source

Minor Changes
  • fd5d337: Added a new backend.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 the config option.

  • 3f34ea9: Throttles Bitbucket Server API calls

  • de6f280: 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 with useRedisSets 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 from app-config.yaml:

    backend:
      cache:
        store: redis
        connection: redis://user:[email protected]:6379
    -   useRedisSets: false
  • 29180ec: BREAKING PRODUCERS: The LifecycleMiddlewareOptions.startupRequestPauseTimeout has been removed. Use the backend.lifecycle.startupRequestPauseTimeout setting in your app-config.yaml file to customize how the createLifecycleMiddleware function should behave. Also the root config service is required as an option when calling the createLifecycleMiddleware function:

    - createLifecycleMiddleware({ lifecycle, startupRequestPauseTimeout })
    + createLifecycleMiddleware({ config,  lifecycle })
  • 277092a: Implemented AzureBlobStorageUrlReader to read from the url of committed location from the entity provider

  • 18a2c00: All middleware used by the default coreServices.http is now exported for use by custom implementations.

Patch Changes

v0.5.3

Compare Source

Patch Changes

v0.5.2

Compare Source

v0.5.1

Compare Source

Patch Changes

v0.5.0

Compare Source

Minor Changes
  • a4bac3c: BREAKING: You can no longer supply a basePath 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 Removed createLifecycleMiddleware and LifecycleMiddlewareOptions 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 from createBackendPlugin, createBackendModule, and createServiceFactory are now simply BackendFeature and ServiceFactory, 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 all coreServices.* 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 your packages/backend/src/index.ts too, where you add plugins, modules, and services. If you were using createServiceFactory 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:

    import {
      coreServices,
      createServiceFactory,
      createServiceRef,
    } from '@​backstage/backend-plugin-api';
    import {
      DefaultIdentityClient,
      IdentityApi,
    } from '@​backstage/plugin-auth-node';
    
    backend.add(
      createServiceFactory({
        service: createServiceRef<IdentityApi>({ id: 'core.identity' }),
        deps: {
          discovery: coreServices.discovery,
        },
        async factory({ discovery }) {
          return DefaultIdentityClient.create({ discovery });
        },
      }),
    );

    The following can be used to implement the token manager service:

    import { ServerTokenManager, TokenManager } from '@&#8203;backstage/backend-common';
    import { createBackend } from '@&#8203;backstage/backend-defaults';
    import {
      coreServices,
      createServiceFactory,
      createServiceRef,
    } from '@&#8203;backstage/backend-plugin-api';
    
    backend.add(
      createServiceFactory({
        service: createServiceRef<TokenManager>({ id: 'core.tokenManager' }),
        deps: {
          config: coreServices.rootConfig,
          logger: coreServices.rootLogger,
        },
        createRootContext({ config, logger }) {
          return ServerTokenManager.fromConfig(config, {
            logger,
            allowDisabledTokenManager: true,
          });
        },
        async factory(_deps, tokenManager) {
          return tokenManager;
        },
      }),
    );
  • 055b75b: BREAKING: Simplifications and cleanup as part of the Backend System 1.0 work.

    For the /database subpath exports:

    • The deprecated dropDatabase function has now been removed, without replacement.
    • The deprecated LegacyRootDatabaseService type has now been removed.
    • The return type from DatabaseManager.forPlugin is now directly a DatabaseService, as arguably expected.
    • DatabaseManager.forPlugin now requires the deps argument, with the logger and lifecycle services.

    For the /cache subpath exports:

    • The 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.
    • Accordingly, CacheManager.forPlugin immediately returns a CacheService instead of a PluginCacheManager. The outcome of this is that you no longer need to make the extra .getClient() call. The old CacheManager with the old behavior still exists on @backstage/backend-common, but the above recommendations apply.
Patch Changes

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 setting backend.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 nodegit
  • 0829ff1: Tweaked development log formatter to include extra fields at the end of each log line
  • 036a843: Provide support for on-prem azure devops
  • Updated dependencies [ad5c56f]
  • Updated dependencies [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 directories
  • 0588be0: Add backend:bundle command for bundling a backend package with dependencies into a deployment archive.
  • b8abdda: Add color to output from versions:bump in order to make it easier to spot changes. Also highlight possible breaking changes and link to changelogs.
  • Updated dependencies [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:
  $data: foo.yaml#myValue # replacing with $include will turn the value into a number
  $data: bar.yaml#myValue # replacing with $include is safe

foo.yaml

myValue: 0xf00

bar.yaml

myValue: bar
```

@​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: Replace register-component plugin with new catalog-import plugin

  • fc6839f: Bump sqlite3 to v5.

    To apply this change to an existing app, change the version of sqlite3 in the dependencies of packages/backend/package.json:

         "pg": "^8.3.0",
    -    "sqlite3": "^4.2.0",
    +    "sqlite3": "^5.0.0",
         "winston": "^3.2.1"

    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 from packages/app/src/sidebar.tsx, and the BuildIcon 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:

    1. The lighthouse block from app-config.yaml.
    2. The @backstage/plugin-lighthouse dependency from packages/app/package.json.
    3. The @backstage/plugin-lighthouse re-export from packages/app/src/plugins.ts.
    4. The Lighthouse sidebar item from packages/app/src/sidebar.tsx, and the RuleIcon 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

@​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:

    • entryPoint
    • issuer
    • cert
    • privateKey
    • decryptionPvk
    • signatureAlgorithm
    • digestAlgorithm

    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

@​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: Change location_update_log columns from nvarchar(255) to text
  • 73e75ea: Add processor for ingesting AWS accounts from AWS Organizations
  • 071711d: Remove sqlite3 as a dependency. You may need to add sqlite3 as a dependency of your backend if you were relying on this indirect dependency.
  • Updated dependencies [5ecd50f]
  • Updated dependencies [00042e7]
  • Updated dependencies [0829ff1]
  • Updated dependencies [036a843]

@​backstage/plugin-catalog-import@​0.3.3

Patch Changes

@​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

@​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 job
  • Updated dependencies [9c09a36]

@​backstage/plugin-scaffolder-backend@​0.3.7

Patch Changes

@​backstage/plugin-search@​0.2.5

Patch Changes

@​backstage/plugin-sentry@​0.3.2

Patch Changes

@​backstage/plugin-tech-radar@​0.3.2

Patch Changes
  • ab08923: Remove test dependencies from production package list
  • bc90917: Updated example data in README.

@​backstage/plugin-techdocs-backend@​0.5.2

Patch Changes

[email protected]

Patch Changes

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: Add FlatRoutes component to replace the top-level Routes component from react-router within apps, removing the need for manually appending /* to paths or sorting routes.
  • Updated dependencies [a08c32c]
  • Updated dependencies [86c3c65]
  • Updated dependencies [27f2af9]

@​backstage/core-api@​0.2.8

Patch Changes
  • a08c32c: Add FlatRoutes component to replace the top-level Routes component from react-router within apps, removing the need for manually appending /* to paths or sorting routes.
  • 86c3c65: Deprecate RouteRef path parameter and member, and remove deprecated routeRef.createSubRouteRef.
  • 27f2af9: Delay auth loginPopup close to avoid race condition with callers of authFlowHelpers.

@​backstage/create-app@​0.3.1

Patch Changes
  • 4e0e3b1: Add missing yarn clean for app.

    For users with existing Backstage installations, add the following under the scripts section in packages/app/package.json, after the "lint" entry:

    "clean": "backstage-cli clean",

    This will add the missing yarn clean for the generated frontend.

  • 352a658: Added "start-backend" script to root package.json.

    To apply this change to an existing app, add the following script to the root package.json:

    "start-backend": "yarn workspace backend start"

@​backstage/dev-utils@​0.1.7

Patch Changes

@​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 or CommonGitPreparer exported by
    @backstage/techdocs-common package, you now need to add pass in a config (from @backstage/config)
    instance as argument.

    <!-- Before -->
        const directoryPreparer = new DirectoryPreparer(logger);
        const commonGitPreparer = new CommonGitPreparer(logger);
    <!-- Now -->
        const directoryPreparer = new DirectoryPreparer(config, logger);
        const commonGitPreparer = new CommonGitPreparer(config, logger);
    

@​backstage/plugin-api-docs@​0.4.2

Patch Changes

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.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added dependencies Pull requests that update a dependency file renovate labels Aug 20, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch 2 times, most recently from 40c8151 to 589032d Compare August 27, 2024 14:17
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.4.3 chore: Update dependency @backstage/backend-defaults to v0.4.4 Aug 27, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch from 589032d to 6f6093f Compare September 17, 2024 15:34
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.4.4 chore: Update dependency @backstage/backend-defaults to v0.5.0 Sep 18, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch from 6f6093f to 424551f Compare October 15, 2024 15:55
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.5.0 chore: Update dependency @backstage/backend-defaults to v0.5.1 Oct 15, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch 2 times, most recently from 1cb0255 to 9e60fd6 Compare October 18, 2024 10:39
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.5.1 chore: Update dependency @backstage/backend-defaults to v0.5.2 Oct 18, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch from 9e60fd6 to bd6a4af Compare November 19, 2024 15:07
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.5.2 chore: Update dependency @backstage/backend-defaults to v0.5.3 Nov 19, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch from bd6a4af to d01fbfd Compare December 17, 2024 15:17
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.5.3 chore: Update dependency @backstage/backend-defaults to v0.6.0 Dec 17, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch from d01fbfd to bd981b7 Compare December 20, 2024 18:10
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.6.0 chore: Update dependency @backstage/backend-defaults to v0.6.1 Dec 20, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch from bd981b7 to 5682b26 Compare December 24, 2024 13:55
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.6.1 chore: Update dependency @backstage/backend-defaults to v0.6.2 Dec 24, 2024
@renovate renovate bot force-pushed the renovate_backstage-backend-defaults-0.x branch from 5682b26 to 2a898e6 Compare January 14, 2025 21:11
@renovate renovate bot changed the title chore: Update dependency @backstage/backend-defaults to v0.6.2 chore: Update dependency @backstage/backend-defaults to v0.7.0 Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file renovate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants