CCVARN (dotnet-ccvarn)

Helper utility for asserting version and generating release notes based on conventional commits

CCVARN helps developers using conventional-commits to have version and release notes automatically created based on these commits.

Table of Contents

• Background
• Install
• Usage
• Maintainers
• Contributing
  • Contributors ✨
• License

Background

CCVARN was created due to a personal need of having the ability to automatically version and create release notes when commits following conventional-commits were being used.

Install

CCVARN can be installed by using the .NET Core toolset by running the following:

dotnet tool install -g dotnet-ccvarn

Usage

The most basic form of using CCVARN in to run

dotnet ccvarn parse

This will assert the version and extract any commits that follow conventional commit. The results is by default written to a JSON file called CCVARN.json (can be overridden by passing in a different file path).

Additionally if you want to have release notes exported as plain text or markdown, you can additionally run:

dotnet ccvarn --output ReleaseNotes.txt --output ReleaseNotes.md

The type of the output is determined based on the file extension specified (currently supported are .txt and .md for release notes, and .json for exporting all information).

Maintainers

@AdmiringWorm

Contributing

CCVARN follows the Contributor Covenant Code of Conduct.

We accept Pull Requests. Please see the contributing file for how to contribute to CCVARN!

Small note: If editing the README, please conform to the standard-readme specification.

This project follows the all-contributors specification. Contributions of any kind is welcome!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Kim J. Nordmo 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

License

GNU General Public License v3.0 or later © Kim J. Nordmo