3 ms·
I'm building a changelog system at the moment. It's basically the github_changelog_generator gem, but without overwriting old changelog entries. In git-cliff te
by cormacrelf 5y ago
I'm building a changelog system at the moment. It's basically the github_changelog_generator gem, but without overwriting old changelog entries. In git-cliff terms, it has `--prepend CHANGELOG.md`. But the data it gives you is a list of closed issues and merged PRs instead of commits.
I like the prepend mode a lot, because I would like to write proper release notes above the autogenerated changes. Machines are only so good at this stuff. I think everyone should use these things in prepend mode.
I am not personally a big fan of conventional-commits, mostly because you can never edit the message if you mess it up, and I am more of a ten-commits-at-a-time person so it's hard to remember. I guess you can put it on a (PR) merge commit. But I also think there's a lot of value in scooping up data from the GitHub API, like github_changelog_generator does. Listing closed issues by whether they were closed in the time between tags is fantastic, it's like if you'd been using milestones all along. This would be a great addition to git-cliff: `--issues` to parse commit messages for GitHub-style issue-closing directives ("fixes #24") and build a list of closed issues to link or render freestanding. Same goes for "Merge pull request #25 from ...".