-
Notifications
You must be signed in to change notification settings - Fork 475
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
Roll-up changelog entries for beta releases #867
Conversation
Codecov Report
@@ Coverage Diff @@
## master #867 +/- ##
=======================================
Coverage 65.10% 65.10%
=======================================
Files 4 4
Lines 149 149
Branches 37 37
=======================================
Hits 97 97
Misses 29 29
Partials 23 23 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, Chris. Maybe during a beta cycle we want to break out the specific changes between betas, but now it does seem more useful to have all the 4.x changes bunched together.
I updated a couple of PR titles for upgrading passport and node-saml to also add "see changelog for breaking changes".
I had just tried to upgrade to passport 4.x myself and also got stung by breaking changes I missed until production. 🤦♂️ The challenge was the breaking changes were spread between passport and node-saml as well. And from reading the passport-saml change, the language of simply "update dependency" didn't convey the risk, because minor dependency updates happen all the change.
So I hope by adding PR titles like "update passport -- see changelog for breaking changes", that will help diligent upgraders find all the details they need for a smooth upgrade.
I'll review the node-saml changelog now.
I started to make the same change in the node-saml repo, but it looks like I don't have an OAuth token set up to run the Github release tool, so generating a new changelog failed for me. But I agree, it seems like a good idea to rollup the beta changelogs there as well. |
No worries. Once you have |
I've made some updates @markstos . What do you think now? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@markstos , this is a PR that addresses your concerns mentioned in #839 (comment). If we want any of the lines in this changelog altered, we just have to change the name of the PR and regenerate the changelog.
I can do this same thing with
node-saml
if we like it.