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

Roll-up changelog entries for beta releases #867

Merged
merged 2 commits into from Jun 9, 2023

Conversation

cjbarth
Copy link
Collaborator

@cjbarth cjbarth commented Jun 8, 2023

@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.

@codecov
Copy link

codecov bot commented Jun 8, 2023

Codecov Report

Merging #867 (4ba1421) into master (0c2cced) will not change coverage.
The diff coverage is n/a.

@@           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

markstos
markstos previously approved these changes Jun 9, 2023
Copy link
Contributor

@markstos markstos left a 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.

@markstos
Copy link
Contributor

markstos commented Jun 9, 2023

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.

@cjbarth
Copy link
Collaborator Author

cjbarth commented Jun 9, 2023

No worries. Once you have passport-saml adjusted to your liking, I'll update this PR and then go over to node-saml and do the same thing. We can iterate until you're happy. One of these days I should see if we can get a GitHub action to do that work...

@cjbarth
Copy link
Collaborator Author

cjbarth commented Jun 9, 2023

I've made some updates @markstos . What do you think now?

Copy link
Contributor

@markstos markstos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!
image

@markstos markstos merged commit a14f25a into node-saml:master Jun 9, 2023
8 checks passed
@cjbarth cjbarth deleted the changelog branch June 9, 2023 21:06
@cjbarth cjbarth added chore Refactoring, etc. to keep code-rot in check. documentation Request for or contribution to documentation labels Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Refactoring, etc. to keep code-rot in check. documentation Request for or contribution to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants