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

Review release procedure #2518

Closed
manusa opened this issue Sep 30, 2020 · 3 comments
Closed

Review release procedure #2518

manusa opened this issue Sep 30, 2020 · 3 comments

Comments

@manusa
Copy link
Member

manusa commented Sep 30, 2020

Description

It has been reported by several users that they've spent a considerable amount of time dealing with breaking changes and remaining clueless upon the procedure they must follow to upgrade their code.

We need to improve our release process so we avoid such situations.

Changelog should highlight in some way if there are breaking changes. Any change that breaks backwards compatibility should include a link (or more details) with information on how to deal with the change.

@manusa manusa added the doc label Sep 30, 2020
@manusa
Copy link
Member Author

manusa commented Oct 5, 2020

We can maybe add an extra subheading for each release Breaking changes.

Each entry in one of the previous sections (Bugs, Improvements, ...) which involves a breaking change (as marked in the PR), should also include an entry in this new subsection.

@matthyx
Copy link
Contributor

matthyx commented Oct 6, 2020

In my particular case, it was more a regression that went thru because of incomplete test coverage... actually I saw that you @rohanKanojia have improved it while fixing in #2490

@stale
Copy link

stale bot commented Jan 11, 2021

This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions!

@stale stale bot added the status/stale label Jan 11, 2021
@stale stale bot closed this as completed Jan 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants