KeepAChangelog.IO

A .NET library for reading and writing files in the https://keepachangelog.com/ format.

Features

• 📖 Parse changelog files into a strongly-typed model
• ✍️ Write new changelogs or update existing ones
• ✅ Validate changelog formatting and structure
• ⛓️‍💥 Zero dependencies

Usage

Read from a file

using KeepAChangelog.IO;

var changelog = Changelog.From("CHANGELOG.md");

Write to a file

changelog.ToFile("CHANGELOG.md");

Create a changelog from scratch

var changelog = Changelog.Create();

Access different parts of the changelog

using System.Linq;
using KeepAChangelog.IO;

var latestRelease = changelog.Releases[0];
var latestFixes = latestRelease.Categories.First(c => c.Type == CategoryType.Fixed).Entries;
// ...

Contributing

Support this project with a ⭐️, open an issue or if you feel adventurous and would like to extend the functionality open a pull request.