Skip to content
Generates release notes that can be published to GitHub
Java Shell Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.mvn/wrapper
ci Fix file permissions Jun 18, 2019
src Reformat code Jun 18, 2019
.gitignore Initial commit Apr 10, 2018
Dockerfile Attempt to fix AdoptOpenJDK download Jun 18, 2019
LICENSE.txt
README.adoc Clarify license Jun 8, 2019
mvnw URL Cleanup Mar 12, 2019
mvnw.cmd URL Cleanup Mar 12, 2019
pom.xml

README.adoc

Generate release notes for a GitHub milestone

To generate markdown release notes that comprise the list of bugs and issues in a GitHub milestone follow these steps:

releasenotes:
  github:
    organization:
    repository:
    username:
    password:
Note
When generating release notes for a public repository, the username and password properties are optional. However, specifying them ensures that you don’t hit GitHub’s rate limit easily.
Tip
If you are only configuring a few properties you can alternatively use application arguments such as --releasenotes.github.organization=…​.
  • Run the following commands:

$ java -jar github-release-notes-generator.jar <milestone> <path_to_generate_file>
Note
The <milestone> may either refer to the milestone number or a name.

Customizing Sections

By default the release notes will contain the following sections:

Title Label Text

New Features

"enhancement"

Bug Fixes

"regression" or "bug"

Documentation

"documentation"

Dependency Upgrades

"dependency-upgrade"

If you want something different then you can add sections YAML:

releasenotes:
  sections:
  - title: "Enhancements"
    emoji: ":star:"
    labels: ["new"]
  - title: "Bugs"
    emoji: ":beetle:"
    labels: ["fix"]

License

This project is Open Source software released under the Apache 2.0 license.

You can’t perform that action at this time.