To generate markdown release notes that comprise the list of bugs and issues in a GitHub milestone follow these steps:
-
Download a release JAR or use the Docker image.
-
Configure the application with the following properties:
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.
|
If you’re using GitHub enterprise, the base url can be set using releasenotes.github.api-url.
|
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.
|
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"]This project is Open Source software released under the Apache 2.0 license.