Do you detest creating release notes for your software applications hosted on GitHub? If so, this is the tool for you.
Using a simple set of configuration properties, you can fully automate the creation and export of Release Notes from your GitHub hosted project.
As an example see this Release for Chocolatey GUI which was created using GitReleaseManager.
GitReleaseManager allows you to:
- Create Draft Releases from a milestone
- Attach assets to an existing release
- Close a milestone
- Publish a Draft Release
- Export all Release Notes for a Project
To install GitReleaseManager as a .NET Global tool, execute:
dotnet tool install --global GitReleaseManager.ToolYou can install GitReleaseManager via Chocolatey by executing:
choco install gitreleasemanager.portableNOTE: Depending on which version of Chocolatey you are using, you may be required to confirm the installation of the application. You can avoid this prompt using the following command:
choco install gitreleasemanager.portable -yIf you are interested in trying out the latest pre-release version of GitReleaseManager then you can use the following installation command:
choco install gitreleasemanager.portable -source https://www.myget.org/F/grm_develop/ -preThis uses the public GitReleaseManager feed which is hosted on MyGet.org
Come join in the conversation about GitReleaseManager in our Gitter Chat Room
If you would like to contribute code or help squash a bug or two, that's awesome. Please familiarize yourself with CONTRIBUTING.
Committers, you should be very familiar with COMMITTERS.
The documentation for GitReleaseManager can be found on here.
GitReleaseManager is brought to you by quite a few people and frameworks. See CREDITS for full information.
Full original credit has to go to the people at Particular Software, without whom this project would not have been possible. They originally created the GitHubReleaseNotes project, which GitReleaseManager is based on, and draws a lot of inspiration from.
Where GitHubReleaseNotes uses a set of fixed configuration, based on Particular's internal usage requirements, GitReleaseManager attempts to be fully configurable, so that the end user can decide what should be done when creating and exporting Release Notes on GitHub. Huge thanks to the people at Particular for their support in helping me create this project. For more information about what has changed between GitHubReleaseNotes and GitReleaseManager, see this issue.
In addition, a large thank you has to go to again Particular Software and the contributors behind the GitVersion Project. GitReleaseManager draws on the work done in that project in terms of initializing and using a YAML configuration file to allow setting of configuration properties at run-time.
Pull-request designed by Richard Slater from The Noun Project.