SemanticRelease.Changelog 1.0.0

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SemanticRelease.Changelog --version 1.0.0
                    


                    

                
NuGet\Install-Package SemanticRelease.Changelog -Version 1.0.0
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.Changelog" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SemanticRelease.Changelog" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SemanticRelease.Changelog" />
                    


                            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.Changelog --version 1.0.0
                    


                    

                
#r "nuget: SemanticRelease.Changelog, 1.0.0"
#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.Changelog@1.0.0
#: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.Changelog&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SemanticRelease.Changelog&version=1.0.0
                    


                            Install as a Cake Tool

SemanticRelease.Changelog

A .NET library for automatically generating and updating CHANGELOG files as part of semantic release workflows.

Overview

SemanticRelease.Changelog is a plugin for the semantic-release ecosystem that automates the creation and maintenance of changelog files. It integrates with your CI/CD pipeline to generate structured, consistent release notes based on your commit history.

Features

  • Automatic generation of CHANGELOG.md files
  • Integration with semantic-release workflows
  • Configurable changelog format
  • Support for dry-run mode to preview changes

Installation

You can install the plugin via the CLI:

dotnet add package SemanticRelease.Changelog

You can also allow the semantic-release tool to resolve the package reference by using it in your semantic-release.json file.

Usage

This library implements the ISemanticPlugin interface from the SemanticRelease.Abstractions package. To use it in your semantic-release workflow:

Add the plugin to your plugins list after any release notes generation plugins:

{
  "pluginConfigs": [
    "SemanticRelease.Changelog"
  ]
}

Configuration

The default configuration uses "CHANGELOG.md" as the target file, but you can customize this:

{
  "pluginConfigs": [
    {
      "name": "SemanticRelease.Changelog",
      "options": {
        "changelogFile": "custom-file-name.md"
      }
    }
  ]
}

At the time of this writing, alternate file formats are NOT supported

Requirements

  • .NET Standard 2.1
  • SemanticRelease.Abstractions package

License

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

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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 81 7/12/2025
1.0.0 78 7/12/2025

# 1.0.0 (2025-07-12)


### Features

* add base plugin functionality ([a3dea5b](https://github.com/DuncanMcPherson/semantic-changelog/commit/a3dea5b7d1d6570edfaaf07effcc56ac5a06c369))