SemanticRelease.NotesGenerator 1.0.1

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package SemanticRelease.NotesGenerator --version 1.0.1
                    


                    

                
NuGet\Install-Package SemanticRelease.NotesGenerator -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SemanticRelease.NotesGenerator" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SemanticRelease.NotesGenerator" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SemanticRelease.NotesGenerator" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add SemanticRelease.NotesGenerator --version 1.0.1
                    


                    

                
#r "nuget: SemanticRelease.NotesGenerator, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package SemanticRelease.NotesGenerator@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=SemanticRelease.NotesGenerator&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SemanticRelease.NotesGenerator&version=1.0.1
                    


                            Install as a Cake Tool

SemanticRelease.NotesGenerator

NuGet License: MIT

A .NET Standard library for generating release notes based on semantic commit messages. This project is inspired by the semantic-release ecosystem for Node.js.

Overview

SemanticRelease.NotesGenerator is a plugin for the SemanticRelease system that automatically generates formatted release notes from your git commit history. It categorizes commits based on conventional commit types and creates a well-structured markdown document.

Features

  • Generates formatted markdown release notes
  • Categorizes commits by type (features, bug fixes, etc.)
  • Supports breaking changes detection
  • Links commits to their GitHub URLs
  • Integrates with the SemanticRelease lifecycle

Installation

Install the package from NuGet:

dotnet add package SemanticRelease.NotesGenerator

Usage

This library implements the ISemanticPlugin interface from the SemanticRelease.Abstractions package, allowing it to be used within the SemanticRelease ecosystem.

using SemanticRelease.NotesGenerator;

// Register the plugin with the SemanticRelease lifecycle
var notesGenerator = new NotesGenerator();
lifecycle.RegisterPlugin(notesGenerator);

Commit Types

The NotesGenerator recognizes the following commit types:

  • feat: Features (new functionality)
  • fix: Bug Fixes
  • docs: Documentation changes
  • refactor: Code Refactoring
  • perf: Performance Improvements
  • test: Tests
  • chore: Chores (maintenance tasks)
  • !: Breaking Changes (as a suffix to a type, or via the string "BREAKING CHANGES" in the commit)

Example Output

## ([1.2.0](https://github.com/user/repo/compare/1.1.0...1.2.0)) (07/11/2025)

### Features

* Add support for custom commit types - 2025 July 11 - ([a1b2c3d](https://github.com/user/repo/commit/a1b2c3d))

### Bug Fixes

* Fix issue with breaking changes detection - 2025 July 10 - ([e4f5g6h](https://github.com/user/repo/commit/e4f5g6h))

Requirements

  • .NET Standard 2.1
  • LibGit2Sharp (0.31.0)
  • SemanticRelease.Abstractions (1.1.0)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Inspiration for this project comes from the node-semver package in the Node.js ecosystem
  • Thanks to the contributors of LibGit2Sharp for providing .NET bindings to libgit2
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 87 7/11/2025
1.0.0 89 7/11/2025

## [1.0.1](https://github.com/DuncanMcPherson/semantic-notes-generator/compare/v1.0.0...v1.0.1) (2025-07-11)


### Bug Fixes

* Add logging for visibility purposes ([1873e1d](https://github.com/DuncanMcPherson/semantic-notes-generator/commit/1873e1d4edf2dd31221c143b2ccff55ea4aa564b))