plugins {
    id("io.github.simonscholz.github.release.notes.plugin") version "1.5.0"
}

gitHubReleaseNotesConfig {
    project.findProperty("GITHUB_TOKEN")?.let{gitHubToken.set(it.toString())}
    project.findProperty("GITHUB_USER_NAME")?.let{username.set(it.toString())}
    project.findProperty("GITHUB_USER_ACCESS_TOKEN")?.let{password.set(it.toString())}
    owner.set("SimonScholz")
    projectName.set("github-release-notes")
    deploymentAnnouncement.set(
        """
:egg: @here {0} will deploy our new release {1} to PROD in a couple of minutes. Changes going live:
\```
{3}
\```
Feel free to explore all release notes and see the full diff in code here: {4}
        """.trimIndent()
    )
}

The values of the deploymentAnnouncement placeholders are:

• {0} - Team Name
• {1} - Release Name
• {2} - Project Name
• {3} - Release Body (Containing the PRs being merged since the last release)
• {4} - Url to the GitHub Release

Adjust the build.gradle.kts file in the example project with your username + personal GitHub access token aka password and desired owner + project.

You can run the following gradle task to create a draft release for your desired project:

./gradlew example:gitHubReleaseNotesTask

In the console you'll also find a proper announcement for the webshop deployment channel which you can copy and paste.

The plugin itself can be found here: https://plugins.gradle.org/plugin/io.github.simonscholz.github.release.notes.plugin

Feel free to open a issue or submit a pull request for any bugs/improvements.

This template is licensed under the MIT License - see the License file for details. Please note that the generated template is offering to start with a MIT license but you can change it to whatever you wish, as long as you attribute under the MIT terms that you're using the template.