Skip to main content
Any Framework

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.

Published
Nov 19, 2023
2y ago
Total Downloads
227.1K
227,117

Install

dotnet add package Octopus.OctoNotes.Tool --version 0.1.729

No framework information available.

README

Changes from Previous Version

No structural changes between v0.1.728 and v0.1.729.

Adoption Assessment

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.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.