The changelog #205
The changelog #205
Conversation
danmichaelo
force-pushed
the
changelog
branch
3 times, most recently
from
e5854a8
to
80e5c45
Compare
danmichaelo
force-pushed
the
changelog
branch
from
80e5c45
to
905e8f2
Compare
|
How about python-semantic-release (repo)? It's a Python port of the semantic-release npm package, which provides a way to semi-automatically determine the version based on the contents of the commit messages included in it. I think the original package actually generates the changelog content as well, or at least has the option to do so. I didn't check if the Python port does the same. |
|
I often find that I have to rewrite things a bit when adding them to the changelog. With such an approach, I would have to take some care during the commit process, and probably also clean up commit messages from PRs, but it's definitely something to consider. Perhaps I should try this approach in a personal project just to see if I'm able to follow the strict commit message style at all :) |
|
Yeah, that was my concern as well. I believe the changelog is generated from PR titles rather than commits, so it shouldn't be hard to edit them after the fact to ensure a mostly clean changelog. But yeah, do try it out first to see if you like it :) such tools should make things easier, not bring added stress to the maintenance process! :P |
In #109 I decided to only update change information in GitHub releases. However, the https://keepachangelog.com/ project have made me rethink that decision and I will try to make the CHANGELOG.md file the primary source for changes from now on.
Ideally, a GitHub release could be generated automatically from the changelog file. I found gh-release, but it's a bit tied to NPM, requiring a package.json file. If someone knows a similar solution that is not tied to NPM, let me know!