Skip to content

GitTools/GitReleaseManager

Repository files navigation

Icon

License Coverage Status Coverity Scan Build Status

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 ChocolateyGUI which was created using GitHubReleaseManager.

GitHubReleaseManager 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

Installation

You can install GitHubReleaseManager via Chocolatey by executing:

choco install githubreleasemanager

If you are interested in trying out the latest pre-release version of GitHubReleaseManager then you can use the following installation command:

choco install githubreleasemanager -source https://www.myget.org/F/ghrm_develop/ -pre

This uses the public GitHubReleaseManager feed which is hosted on MyGet.org

Build Status

AppVeyor

AppVeyor Build Status

Chat Room

Come join in the conversation about GitHubReleaseManager in our Gitter Chat Room

Join the chat at https://gitter.im/gep13/GitHubReleaseManager

Contributing

If you would like to contribute code or help squash a bug or two, that's awesome. Please familiarize yourself with CONTRIBUTING.

Committers

Committers, you should be very familiar with COMMITTERS.

Credits

GitHubReleaseManager 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 GitHubReleaseManager 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, GitHubReleaseManager 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 GitHubReleaseManager, see this issue.

In addition, a large thank you has to go to again Particular Software and the contributors behind the GitVersion Project. GitHubReleaseManager 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.

Icon

Pull-request designed by Richard Slater from The Noun Project.