-
Notifications
You must be signed in to change notification settings - Fork 114
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
Add support for generating Changelog.md file #121
Comments
@hellais that's what |
Well by that logic then this tool should not exist at all. Moreover, the It's generally much easier, assuming the developer follows good practices when writing their commit messages, to look at the commit message history. |
This tool isn't for generating changelogs though. It's to automate the process of releasing an npm package to the central repository and including the relevant details on the Github release page as a convenience to users. But realistically, anyone inside of a Git repository looking at a changelog could just run the relevant git command if that's what they're after.
Correct, sorry. I meant
I use both commands frequently to do my job as I don't like to rely on humans to tell me what parts of code have changed. If I care to know exactly what happened between two points in time, I will trust a So you're right, I've not had an unfortunate experience. But to each their own, I understand Git has a little bit of a learning curve.
Right - but the problem with changelog files themselves is that they are an artifact of information derived from the repository contents. Artifacts are generally considered bad practice to include in a repository for two reasons:
While changelogs aren't (normally) a risk to include, philosophically they do not belong in the repository as the git log contents are to be considered the source of truth. |
@Qix- thanks for your detailed response. You bring up some very valid points that I hadn't considered |
I think it would be nice to have as an option. For things that rely on changelog.md being there like vsce, this would help a lot. Yes you could use |
It's great the github releases are automatically generated, but as a user of changelogs I find it more useful to just look at a single
Changelog.md
file instead of having to page through (sometimes) numerous pages of github releases to understand all the changes that happened between the version I was at and the latest.It would be great if release were to also automatically generate and update a Changelog.md file and drop it into the root of the repository.
Edit: I would be happy to implement this if it would be used for the generation of releases in next.js
This is following up a discussion had with @timneutkens in the next.js channel.
The text was updated successfully, but these errors were encountered: