GitHub Release Notes Creator

... is a Java-based tool for automatically creating release notes for software projects hosted on GitHub. By using closed issues associated with specific milestones, accurate release documentation is generated. It connects to the GitHub API, retrieves relevant issue data and formats the information into structured release notes.
The format of the output is Markdown.

For accessing the GitHub API, the Java API for GitHub is used.

If you find a bug or certain features are missing, don’t hesitate to file an issue on Github.

The state of the project is BETA.

Give it a try!

Configuration

ghrnc:
  repo: owner/project
  github-token: ghp_abcdefghijklmnopqrstxyz0123456789bla
  sections:
    - title: "Enhancements"
      labels: ["enhancement"]
    - title: "Bugs"
      labels: ["bug"]
    - title: "Improvements"
      labels: ["improvement"]

The ghrnc.github-token is optional but increases the rate limit of GitHub. If required, the endpoint of the GitHub API could be set with ghrnc.base-url.

If sections isn’t set, the following default is used:

ghrnc:
  sections:
    - title: ":star: New Features"
      labels: ["enhancement"]
    - title: ":lady_beetle: Bug Fixes"
      labels: ["bug"]
    - title: ":notebook_with_decorative_cover: Documentation"
      labels: ["documentation"]

Running Standalone

Download the last release jar.

java -jar ghrnc.jar <milestone> <path-to-ghrnc-config.yaml> [<path-to-output-changelog.md>]

Required parameters:

• milestone: The milestone for which the release notes should be generated.

• path-to-ghrnc-config.yaml: The configuration file, see above.

Optional parameter:

• path-to-output-changelog.md: The generated release notes file. If it isn’t, 'release-notes.md' is used.