docs: remove the changelog #1464
Conversation
|
Imo that's a bad idea. Release notes directly in github are fine, but a single changelog file is easier to search and also available outside of github. |
|
I think it's pretty easy to see all the changes in https://github.com/node-fetch/node-fetch/releases devided into a own section. It's only more annoying to keep that up to date with what you are doing... |
|
True, the release page looks pretty good. I hadn't checked them in a while and Github has improved them. The other point still stands that the release notes are not available when I have the repository checked out. |
There was a problem hiding this comment.
The other point still stands that the release notes are not available when I have the repository checked out.
Since the changelog is generated from the Git log one could argue that the changelog is available by running git log.
In any way, I don't think that having a changelog file available when checking out the repo is enough upside to warrant all the extra work that it puts on us...
|
Funnily enough, I just had to search the changelog today due to dependabot alerts, and it was a harder experience with releases. For example, with a full changelog open I can easily see chronological order whereas its harder in releases. Also, I tried searching |
|
Can't the semantic-release-bot update a file with the changes? It's touching the repo anyway, right? |
Maybe @gr2m can answer that question. |
|
the nice thing about using github tags and releases is that If you want a changelog file, there is a plugin for that: I agree the best would be a better search for releases built into github.com @Belco90 built https://octoclairvoyant.vercel.app/comparator which is pretty great! I use it for that purpose sometimes |
Cool! with comparator i feel like i don't need any changelog plugin |
|
🎉 This PR is included in version 4.0.0-beta.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
Uh, how am I supposed to see which changes happened in 3.0.0 and what I have to do to upgrade with this deleted? The 3.0.0 and 3.0.0-beta releases mostly just links to the deleted changelog. I also agree with the others that a single changelog file is much easier to use, and it also has the benefit of being able to be read from the git checkout, not having to open the browser. |
|
🎉 This PR is included in version 3.2.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Purpose
with semantic release bot that can auto generate release changes then we no longer need this changelog.
also update the PR template to reflect this,
Fixeswasn't a valid command to auto close issues...