Skip to main content
OctoNotes.Generator package icon

OctoNotes.Generator

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.

Total Downloads
359.7K
359,714
Published
Aug 19, 2022
Latest stable version

Install

.NET CLI
dotnet add package OctoNotes.Generator --version 0.1.166
Package Manager Console
Install-Package OctoNotes.Generator -Version 0.1.166
PackageReference
<PackageReference Include="OctoNotes.Generator" Version="0.1.166" />

Frameworks

.NETStandard2.0

Dependencies

OctoNotes.Core
.NETStandard2.0
[0.1.166, )
LibGit2Sharp
.NETStandard2.0
[0.26.2, )
Serilog
.NETStandard2.0
[2.11.0, )

Adoption guide

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

NuGet marks this package as deprecated and points to Octopus.OctoNotes.Generator as an alternative.

Compatibility metadata lists 1 target framework; confirm the exact target used by your application.

How to read this guidance

Sources: published NuGet v3 registry metadata and explicit NuBrowse editorial guides. Refresh: package metadata is refreshed from NuGet when the page loads. Limit: this is not a security, legal or compatibility guarantee; validate the selected version in your project.

Useful next steps

Move from package metadata to a concrete selection or review workflow.