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

Delete the CHANGELOG.md #1372

Closed
jimmywarting opened this issue Nov 10, 2021 · 9 comments · Fixed by #1464
Closed

Delete the CHANGELOG.md #1372

jimmywarting opened this issue Nov 10, 2021 · 9 comments · Fixed by #1464

Comments

@jimmywarting
Copy link
Collaborator

jimmywarting commented Nov 10, 2021

@node-fetch/core what do you think about ditching the CHANGELOG.md?

Everytime we release a new tag, then we have the possibility to auto generate a changelog from all PR/commits that where added.
that way we don't have to manually keep the changelog up to date.

@jimmywarting
Copy link
Collaborator Author

Here is an example from latest release: https://github.com/node-fetch/node-fetch/releases/tag/v3.1.0

@LinusU
Copy link
Member

LinusU commented Nov 10, 2021

I'm 👍 on this

This is how I do it in all of my repositories as well

@gr2m
Copy link
Collaborator

gr2m commented Nov 10, 2021

Once we merge #1270, releases with changelogs will be auto-generated. I'm okay with deleting the CHANGELOG.md file.

@ramya-rao-a
Copy link

One catch here is that the generated changelog in the releases does not categorize the changes into breaking changes vs new features vs bug fixes. When there is a major version update, one of the things important for consumers would be to understand what the breaking changes are

@gr2m
Copy link
Collaborator

gr2m commented Dec 15, 2021

That's not right, semantic-release does separate bug fixes, features, and breaking changes in the release notes it generates.

@gr2m gr2m closed this as completed Dec 15, 2021
@gr2m gr2m reopened this Dec 15, 2021
@ramya-rao-a
Copy link

Apologies, I did not see such break up in https://github.com/node-fetch/node-fetch/releases/tag/v3.0.0 and so the comment. I realize now that the v3 release might have been before adapting the auto generated changelog

@gr2m
Copy link
Collaborator

gr2m commented Dec 15, 2021

we don't use semantic-release yet, #1270 is pending

@github-actions
Copy link

🎉 This issue has been resolved in version 4.0.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions
Copy link

github-actions bot commented Mar 1, 2022

🎉 This issue has been resolved in version 3.2.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants