Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Add changelogs for releases please #574
Good to know.
I love this project but I don't have much time for it. I will recommend https://github.com/conventional-changelog/conventional-changelog-cli to make changelogging easier.
@dcodeIO I'm quite familiar with the angular changelog + semantic release type stuff, would you like me to set it up + make a PR?
There's two approaches to this.
In both approaches, you use a strong commit format:
There's a number of different types of commits, detailed in the Angular style guide. There's also a tool called
The scope is optional but will show up in the changelog - it's like a category. The commit message is all lower case and shows up in changelog if it's a feat, fix, or refactor.
The two approaches are:
Which would you prefer? I use both options in my projects. I really like semantic release but if you want strong control over the version # then use option 2.
I usually tend to break things into what I actually need, which is a changelog, not another project's release process. While the above isn't fully automated yet, it is capable of generating changelogs including (limited) backwards compatibility for old commits based on my usual phrasing.