OctoNotes.Generator

v0.0.108-release-notesPre-release

OctoNotes is a tool for generating release notes from Git repositories. In a perfect, trunk-based world, there would be a single, linear graph between versions of an application. In the real world, however, that's almost never the case. Many releases will have hotfixes; many applications will have LTS branches or maintenance releases; not to mention pull requests and other reasons for branches, both short-lived and long. OctoNotes takes a slightly different view of release notes. OctoNotes views the Git revision graph as the single source of truth. If a bug was fixed in a commit, that bug is only fixed in revisions containing that commit. If a feature was added between versions X and Y, it will appear in the Git revision graph as a commit somwehere between those two points. By leveraging Git tags, OctoNotes can pinpoint precisely where in a Git revision graph a change was introduced, and provide the release notes for just the commits between two points on that graph.