https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker

🌶️ dotnet-release-note : Release Note Maker
https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker

nfv2 releasenotegenerator tool towncrier

Last synced: 11 months ago
JSON representation

🌶️ dotnet-release-note : Release Note Maker

• Host: GitHub
• URL: https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker
• Owner: netpyoung
• License: mit
• Created: 2024-11-20T04:24:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-15T23:19:26.000Z (about 1 year ago)
• Last Synced: 2025-06-16T00:36:29.403Z (about 1 year ago)
• Topics: nfv2, releasenotegenerator, tool, towncrier
• Language: C#
• Homepage: https://netpyoung.github.io/NF.Tool.ReleaseNoteMaker/
• Size: 8.65 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# NF.Tool.ReleaseNoteMaker

[![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker)

[![.NET Test Workflow](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/actions/workflows/dotnet-test.yml/badge.svg)](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/actions/workflows/dotnet-test.yml)

[![Document](https://img.shields.io/badge/document-docfx-blue)](https://netpyoung.github.io/NF.Tool.ReleaseNoteMaker/)

[![License](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/LICENSE.md)

[![NuGet](https://img.shields.io/nuget/v/dotnet-release-note.svg?style=flat&label=NuGet%3A%20dotnet-release-note)](https://www.nuget.org/packages/dotnet-release-note/)

- Reinvent the wheel

## Overview

`NF.Tool.ReleaseNoteMaker (akka. dotnet-release-note)` simplifies changelog creation in .NET projects by mimicking the functionality of Python's [twisted/towncrier](https://github.com/twisted/towncrier).

It enables developers to manage changelog entries incrementally and consolidate them during release.

## Install

``` bash

dotnet tool install --global dotnet-release-note

```

## Document

- [Documentation](https://netpyoung.github.io/NF.Tool.ReleaseNoteMaker/docs/concept.html)

## Dependencies

- use [Toml format](https://toml.io/en/) and [xoofx/Tomlyn library](https://github.com/xoofx/Tomlyn) for Config file.

- use [T4 template](https://learn.microsoft.com/en-us/visualstudio/modeling/code-generation-and-t4-text-templates) and [mono/t4 library](https://github.com/mono/t4).

- use [Spectre.Console](https://spectreconsole.net/) for console output.

- use [Spectre.Console.Cli](https://spectreconsole.net/cli/) for parse args.

- use [SmartFormat](https://github.com/axuno/SmartFormat) for format string.

- use [sebastienros/fluid](https://github.com/sebastienros/fluid) for [liquid](https://shopify.github.io/liquid/)

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/LICENSE.md) file for details.