tomware.Releasy 0.11.0

dotnet tool install --global tomware.Releasy --version 0.11.0
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local tomware.Releasy --version 0.11.0
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=tomware.Releasy&version=0.11.0
nuke :add-package tomware.Releasy --version 0.11.0

build NuGet

releasy

releasy - a simple release notes tool.

What is the tool for?

Writing and maintaining changelogs or release notes is not something a developer likes to spend time for nor is it fun to gather every information for a feature right before release time and write your changelogs or release notes late after you implemented a particular feature.

releasy offers a pragmatic but opinionated approach to provide changelog or release note entries within a pull-request (PR), store them until release date and generate the artifacts as a part of your build process when your about to release a new version.

The releasy-tool allows the following processes:

  • Adding a changelog entry: Provided by the developer within a PR.
  • Adding a release note entry: Provided by the developer within a PR.
  • Creating release notes: Created out of existing release note entries within the repository as a part of the build pipeline.
  • Updating a CHANGELOG.md-file: Created out of existing changelog entries within the repository as a part of the build pipeline.

How to use

List all arguments

releasy -h

Usage: releasy [command] [options]

Options:
  -?|-h|--help         Show help information.

Commands:
  add-changelog        Creates a new changelog entry (i.e. releasy add-changelog -i "my-issue-id" -p "feature" -t "audit" -m "My super duper text")
  add-releasenote      Creates a new release note entry (i.e. releasy add-releasenote -i "my-issue-id" -p "feature" -t "audit" -m "My super duper text")
  create-releasenotes  Creates releasenotes based on release note entries for a dedicated release (i.e. releasy create-releasenotes -v "1.2.3" -p "some-permalink")
  update-changelog     Updates the CHANGELOG.md based on changelog entries for a dedicated release (i.e. releasy update-changelog -v "1.2.3" -p "some-permalink")

Run 'releasy [command] -?|-h|--help' for more information about a command.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
0.11.0 67 4/17/2024
0.10.0 216 11/22/2023
0.9.0 269 9/6/2023
0.8.0 174 6/8/2023
0.7.0 153 6/8/2023
0.6.0 289 3/15/2023
0.5.1 340 1/22/2023
0.5.0 313 1/22/2023
0.4.0 325 11/17/2022
0.3.0 287 11/17/2022
0.2.0 292 11/17/2022
0.1.0 350 11/17/2022