Merge pull request #53 from anenviousguest/fix/52-generate-changelog

Fixes #52: added support for automatically generated release notes.

README.md

@@ -59,6 +59,20 @@ Additional Parameters:
 
 The plugin is available on Maven central
 
+## Note on release description
+The easiest way of getting a good release description (aka release notes or changelog) is to defer its generation to the GitHub. So if you completely leave out
+the `<description>` configuration parameter, then GitHub will generate a meaningful description for you. Otherwise, if description _is_ supplied, it will be 
+prepended to one generated by GitHub.
+
+Below is an example of how the auto-generated release notes by GitHub could look like:
+
+<img src="https://github.com/jutzig/github-release-plugin/assets/8439575/4e9479a5-a93d-420f-8153-06ad74ab48b7" width="500" alt="Screenshot of autogenerated GitHub release notes" />
+
+You can read how to customize release notes format in [GitHub documentation][github-release-notes-format].
+
 ## Note on the GitHub API endpoints
 The endpoint for GitHub API is inferred from `<scm>` connection string. When missing, it by default would use the public endpoint at https://api.github.com.
 If you want to upload to a GitHub enterprise instance, then a respective `<scm>` connection string must be specified.
+
+<!-- Links, sorted alphabetically -->
+[github-release-notes-format]: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes

pom.xml

@@ -207,7 +207,7 @@
 		<dependency>
 			<groupId>org.kohsuke</groupId>
 			<artifactId>github-api</artifactId>
-			<version>1.317</version>
+			<version>1.318</version>
 		</dependency>
 
 		<dependency>

src/main/java/de/jutzig/github/release/plugin/UploadMojo.java

@@ -82,7 +82,7 @@ public class UploadMojo extends AbstractMojo implements Contextualizable{
 	/**
 	 * The release description
 	 */
-	@Parameter(property = "project.description")
+	@Parameter
 	private String description;
 
 	/**
@@ -189,6 +189,7 @@ public void execute() throws MojoExecutionException {
 			if (release == null) {
 				getLog().info("Creating release "+releaseName);
 				GHReleaseBuilder builder = repository.createRelease(tag);
+				builder.generateReleaseNotes(true);
 				if(description!=null) {
 					builder.body(description);
 				}