Conversation
awanlin
left a comment
There was a problem hiding this comment.
Hi @kuangp, I triggered this version bump sooner as anyone who does the upgrade of their Backstage instance to 1.50.x and uses the search module will hit an error on start up - TypeError: Cannot read properties of undefined (reading 'id') - this is due to the breaking change removal of the catalogServiceRef alpha export.
| onBehalfOf: await this.auth.getOwnServiceCredentials(), | ||
| targetPluginId: 'catalog', | ||
| }); | ||
| const credentials = await this.auth.getOwnServiceCredentials(); |
There was a problem hiding this comment.
I'm not sure this is right, need to triple check.
There was a problem hiding this comment.
Pull request overview
Upgrades the ADR workspace/plugins to align with Backstage release v1.50.1, including adapting the ADR search backend module to updated catalog access patterns.
Changes:
- Bump Backstage and related package dependencies across ADR workspace packages to versions compatible with v1.50.1.
- Update
search-backend-module-adrto usecatalogServiceRef/CatalogService(and credentials-based calls) instead of the previous discovery + catalog client approach. - Update generated API reports and add a changeset for the version bump.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| workspaces/adr/plugins/search-backend-module-adr/src/index.ts | Switches to stable catalogServiceRef wiring and removes discovery dependency. |
| workspaces/adr/plugins/search-backend-module-adr/src/collators/DefaultAdrCollatorFactory.ts | Migrates collator catalog access from CatalogClient+discovery/token to CatalogService+credentials. |
| workspaces/adr/plugins/search-backend-module-adr/report.api.md | Reflects the updated public API surface for the backend module. |
| workspaces/adr/plugins/search-backend-module-adr/package.json | Dependency bumps for Backstage v1.50.1 compatibility. |
| workspaces/adr/plugins/adr/report-alpha.api.md | Generated API report updates (ordering/type surface changes). |
| workspaces/adr/plugins/adr/package.json | Dependency bumps for Backstage v1.50.1 compatibility. |
| workspaces/adr/plugins/adr-common/package.json | Dependency bumps for Backstage v1.50.1 compatibility. |
| workspaces/adr/plugins/adr-backend/package.json | Dependency bumps for Backstage v1.50.1 compatibility. |
| workspaces/adr/package.json | Updates tooling deps for Backstage v1.50.1 (cli/repo-tools, adds cli-defaults). |
| workspaces/adr/backstage.json | Updates declared Backstage version to 1.50.1. |
| workspaces/adr/.changeset/version-bump-1-50-1.md | Adds changeset to publish updated ADR packages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| '@backstage-community/search-backend-module-adr': minor | ||
| --- | ||
|
|
||
| Backstage version bump to v1.50.1 |
There was a problem hiding this comment.
The changeset text only mentions a Backstage version bump, but this PR also introduces a breaking public API change in @backstage-community/search-backend-module-adr (collator options now require CatalogService and no longer accept CatalogApi + DiscoveryService). Please update the changeset description to call out the API change and migration guidance, and double-check the chosen bump level is consistent with how this repo communicates breaking changes for 0.x packages.
| Backstage version bump to v1.50.1 | |
| Backstage version bump to v1.50.1. | |
| `@backstage-community/search-backend-module-adr` also includes a breaking public API change in this release. The ADR collator options now require `CatalogService`; passing `CatalogApi` and `DiscoveryService` is no longer supported. | |
| To migrate, update ADR collator construction to provide a `CatalogService` instance instead of the previous `CatalogApi` + `DiscoveryService` pair. The package version remains a `minor` bump here to match this repo's versioning approach for breaking changes in `0.x` packages. |
| export type AdrCollatorFactoryOptions = { | ||
| /** | ||
| * Function used to filter ADR file paths. | ||
| * Defaults to filtering paths following MADR filename format. | ||
| */ | ||
| adrFilePathFilterFn?: AdrFilePathFilterFn; | ||
| /** | ||
| * Plugin cache manager | ||
| */ | ||
| cache: CacheService; | ||
| /** | ||
| * App Config | ||
| */ | ||
| config: RootConfigService; | ||
| /** | ||
| * Catalog API client. Defaults to CatalogClient. | ||
| */ | ||
| catalogClient?: CatalogApi; | ||
| /** | ||
| * Plugin Endpoint Discovery client | ||
| * Catalog service client. | ||
| */ | ||
| discovery: DiscoveryService; | ||
| catalogClient: CatalogService; | ||
| /** |
There was a problem hiding this comment.
AdrCollatorFactoryOptions is marked @public and is re-exported from the package, but this change replaces the previous catalogClient?: CatalogApi + discovery: DiscoveryService shape with a required catalogClient: CatalogService. That is a breaking API change for any consumers constructing DefaultAdrCollatorFactory directly. If external use is expected, consider keeping backwards compatibility (e.g., accepting both shapes / deprecating the old fields) or ensure the versioning + release notes clearly signal the breaking change and provide a migration path.
|
@awanlin I think this needs your approval to merge since you requested changes |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 13 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,3 +1,3 @@ | |||
| { | |||
| "version": "1.49.2" | |||
| "version": "1.50.2" | |||
There was a problem hiding this comment.
The PR description/changelog links mention upgrading to Backstage v1.50.1, but this workspace is being bumped to 1.50.2 here. Please update the PR description (and any referenced changelog/upgrade-helper links) to match the actual target version, or adjust the version if 1.50.1 was intended.
| '@backstage-community/search-backend-module-adr': minor | ||
| --- | ||
|
|
||
| Backstage version bump to v1.50.2 |
There was a problem hiding this comment.
This changeset filename suggests 1.50.1, but the content says the bump is to v1.50.2. Renaming the changeset file to reflect 1.50.2 would avoid confusion when scanning changesets/history.
| Backstage version bump to v1.50.2 | |
| Backstage version bump to v1.50.1 |
|
updated to bump to 1.50.2 |
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
Signed-off-by: Phil Kuang <pkuang@factset.com>
Signed-off-by: Phil Kuang <pkuang@factset.com>
Signed-off-by: Phil Kuang <pkuang@factset.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 12 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| { | ||
| "version": "1.49.2" | ||
| "version": "1.50.3" | ||
| } |
There was a problem hiding this comment.
backstage.json bumps the workspace Backstage version to 1.50.3, but the PR title/changeset text indicate v1.50.2 (and most other workspaces are on 1.50.2). Please align this version with the intended target release, and update the PR metadata/changeset text accordingly if 1.50.3 is actually desired.
|
updated to bump to 1.50.3 |
|
Sorry for the hold up @kuangp, approved! |
Backstage release v1.50.1 has been published, this Pull Request contains the changes to upgrade adr to this new release
Please review the changelog before approving, there may be manual changes needed:
Created by Version Bump 24481949843