Add additional thoughts on rolling out breaking changes #2457
Conversation
kfcampbell
added
the
Type: Documentation
|
It may be good to note that for changes requiring type changes, |
| 1. app | ||
| 1. octokit/octokit.js | ||
| 1. octokit/rest.js | ||
|
|
There was a problem hiding this comment.
Do we (or should we) have a procedure for how often we diff the beta branch with main and create new releases?
There was a problem hiding this comment.
Usually the two shouldn't diverge, beta branches should be short lived. Or is your question about something else?
There was a problem hiding this comment.
I don't think there is a procedure, however one should create a draft PR for the next major version merging beta into main, ex: octokit/request.js#586 and then mark it ready for review when it is ready
There was a problem hiding this comment.
In that case, should I amend the procedure to contain something like:
"After the breaking changes are combined and tested in the beta branch, merge the beta branch into main using a PR with "BREAKING CHANGE" in the body as documented above. beta branches are intended to be short-lived."
There was a problem hiding this comment.
I'ved added similar language to the PR; please let me know what you think!
There was a problem hiding this comment.
Good pony by @wolfy1339, we should create beta pull requests as drafts until all planned breaking changes have been merged into it
There was a problem hiding this comment.
Maybe add that
- beta branches should be deleted first and re-created based on main
- Once the first pull request is merged into beta, create a draft pull request from beta to main with the title vX where X is the next breaking version.
3 Once all breaking changes are merged into beta, test and set the pull request to ready for review
There was a problem hiding this comment.
Sounds good! I've now done so.
| 1. app | ||
| 1. octokit/octokit.js | ||
| 1. octokit/rest.js | ||
|
|
There was a problem hiding this comment.
Usually the two shouldn't diverge, beta branches should be short lived. Or is your question about something else?
|
Good idea @wolfy1339! Would that go at the top of the chain since it's a dependency of many other modules? |
|
That sounds right |
|
I've updated the list accordingly! |
|
🎉 This PR is included in version 3.0.0-beta.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 2.0.19 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Today we talked about how to roll out breaking changes safely in the octokit.js ecosystem. This PR captures that discussion in a more durable place.