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

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

Closed
agnes512 opened this issue Mar 11, 2020 · 5 comments
Closed

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

agnes512 opened this issue Mar 11, 2020 · 5 comments
Labels
CLI developer-experience Issues affecting ease of use and overall experience of LB users stale

Comments

@agnes512
Copy link
Contributor

Inspired by #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
Copy link
Member

dhmlau commented Mar 11, 2020

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
Copy link
Contributor

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
Copy link
Contributor

See #4866

@stale
Copy link

stale bot commented Dec 25, 2020

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 stale bot added the stale label Dec 25, 2020
@stale
Copy link

stale bot commented Jul 14, 2021

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.

@stale stale bot closed this as completed Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI developer-experience Issues affecting ease of use and overall experience of LB users stale
Projects
None yet
Development

No branches or pull requests

4 participants