From 4e67bcbcd27b812ae14b95d10d2b93d6c4205977 Mon Sep 17 00:00:00 2001 From: Olle Jonsson Date: Mon, 24 Sep 2018 06:38:23 +0200 Subject: [PATCH] README: Include Example of Release Summary - fixes #678 - thanks so much for authoring the example, @mob-sakai --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 59d35f6b1..e1e95ac7a 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,32 @@ You can look for params names from the [parser source code (#setup_parser)](http - Customize lots more! Tweak the changelog to fit your preferences :tophat: (*See `github_changelog_generator --help` for details)* +### Using the summary section feature + +For each version, you can add a _release summary_ with text, images, gif animations, +etc, and show new features and notes clearly to the user. This is done using GitHub metadata. + +**Example**: adding the release summary for v1.0.0: + +1. Create a new GitHub Issue +2. In the Issue's _Description_ field, add your release summary content +``` +![image](https://user-images.githubusercontent.com/12690315/45935880-006a8200-bfeb-11e8-958e-ff742ae66b96.png) + +Hello, World! :tada: +``` +3. Set the Issue Label `release-summary` and add it to the GitHub Milestone `v1.0.0` +4. Close the Issue and execute `github-changelog-generator` +5. The result looks like this: +> ## [v1.0.0](https://github.com/skywinder/github-changelog-generator/tree/1.0.0) (2014-11-07) +> [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.1.0...1.0.0) +> +> ![image](https://user-images.githubusercontent.com/12690315/45935880-006a8200-bfeb-11e8-958e-ff742ae66b96.png) +> +> Hello, World! :tada: +> +> **Implemented enhancements:** +> - Add some features ### Alternatives