Skip to main content
Octopus.OctoNotes.Tool package icon

Octopus.OctoNotes.Tool

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
225.4K
225,403
Published
Nov 27, 2022
Latest stable version

Install

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

Frameworks

No framework metadata available.

Dependencies

No declared dependencies.

Adoption guide

A verified publisher signal is available. Assess fit from the package's supported frameworks, license and dependency graph rather than popularity alone.

No target framework metadata is available. Confirm compatibility in a representative project before standardising on this package.

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.