Info
| Version: | 0.1.171 |
| Author(s): | Octopus Deploy Pty. Ltd. |
| Last Update: | Monday, August 22, 2022 |
| .NET Fiddle: | Create the first Fiddle |
| Project Url: | https://github.com/OctopusDeploy/OctoNotes |
| NuGet Url: | https://www.nuget.org/packages/OctoNotes.Generator |
Install
Install-Package OctoNotes.Generator
dotnet add package OctoNotes.Generator
paket add OctoNotes.Generator
OctoNotes.Generator Download (Unzip the "nupkg" after downloading)
Dependencies
- OctoNotes.Core(>= 0.0.328)
- LibGit2Sharp(>= 0.26.2)
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.