search

loopbackio / loopback-next

LoopBack makes it easy to build modern API applications that require complex integrations.
https://loopback.io
Other
4.95k stars 1.07k forks source link

Better Way to Announce Breaking Changes to Help Users Find Them #4864

Closed agnes512 closed 3 years ago

agnes512 commented 4 years ago

Inspired by https://github.com/strongloop/loopback-next/issues/4156

We have CHANGELOG.md to keep track all the updates/changes. But not all users would check the files. And it doesn't remind users what changes might need to make after upgrading to new version of LB4.

We'd like to improve the way how we communicate breaking changes and make the migration guides easier to find like what we did in #4080. So that it's easier for users to find what are updated and what changes need to be done to make the old version of LB4 apps compatible with new updates.

Acceptance Criteria

TBD

dhmlau commented 4 years ago

One suggestion from @raymondfeng, during our last estimation meeting, is to have the change log to aggregate all the change logs from all the packages, so that breaking changes are more easily discovered.

dougal83 commented 4 years ago

The upgrade process could potentially be expanded in future to automatically update changes but it would be quite a lot of work! Prior art being Angular's ng update schematics.

raymondfeng commented 4 years ago

See https://github.com/strongloop/loopback-next/pull/4866

stale[bot] commented 3 years ago

This issue has been marked stale because it has not seen activity within six months. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository. This issue will be closed within 30 days of being stale.

stale[bot] commented 3 years ago

This issue has been closed due to continued inactivity. Thank you for your understanding. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository.