From ed06743b93c96795503cbf64949ee55ce0e3090e Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Mon, 2 Feb 2015 18:54:59 +0200 Subject: [PATCH 1/3] add example --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 15cde08..29e8d1d 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,30 @@ You're almost done! [sudo] gem install github_changelog_generator +## Example: -#Features +># Changelog +> +> ## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10) +> #### 09/01/15 +> - *Merged pull-request:* add header file to public [\#115](https://github.com/skywinder/ActionSheetPicker-3.0/pull/115) +> ([skywinder](https://github.com/skywinder)) +> +> - *Merged pull-request:* Fix bad interaction with Git submodules. +> [\#112](https://github.com/skywinder/ActionSheetPicker-3.0/pull/112) +> ([JimDabell](https://github.com/JimDabell)) +> +> - *Implemented enhancement:* Should have minimum/maximum date property exposed +> [\#97](https://github.com/skywinder/ActionSheetPicker-3.0/issues/97) +> +> ## [1.3.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.9) +> #### 11/12/14 +> - *Closed issue:* Bad interaction with submodules [\#111](https://github.com/skywinder/ActionSheetPicker-3.0/issues/111) +> +> - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122) + + +##Features - **Fully automate changelog generation** - all you need to do - is close issue or merge pull-request by **Github issue tracker** - Automatically split issues by type: @@ -27,7 +49,7 @@ You're almost done! - Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version - Ability to exclude some issues from changelog (by labels) -## Usage +## Usage: **It's really simple**: - If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run: From b39c6445090e0c6f29979ef2c7efc40c8b03534d Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Mon, 2 Feb 2015 19:04:31 +0200 Subject: [PATCH 2/3] rm --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 29e8d1d..9b8288a 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,6 @@ You're almost done! ## Example: -># Changelog -> > ## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10) > #### 09/01/15 > - *Merged pull-request:* add header file to public [\#115](https://github.com/skywinder/ActionSheetPicker-3.0/pull/115) From 192816924fb9bb3ad3ddd6cddea4f3173610b103 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Mon, 2 Feb 2015 19:16:06 +0200 Subject: [PATCH 3/3] update --- README.md | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 9b8288a..2b857dd 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,20 @@ GitHub Changelog Generator Changelog generation has never been so easy. -This script automatically generate change-log from your tags and merged pull-requests. +**Fully automate changelog generation** - This script automatically generate change-log from your tags, issues and merged pull-requests from your project's **Github issue tracker**. ## Installation: -You're almost done! [sudo] gem install github_changelog_generator -## Example: +## Output example: + +- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project +- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command: + + github_changelog_generator -u skywinder -p ActionSheetPicker-3.0 + +- In general it looks like this: > ## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10) > #### 09/01/15 @@ -34,16 +40,14 @@ You're almost done! > - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122) -##Features - -- **Fully automate changelog generation** - all you need to do - is close issue or merge pull-request by **Github issue tracker** +##Features and the benefits and advantages of this project to others: +- Custom date format supported - Automatically split issues by type: - **Issues** (closed issues w/o any labels) - **Merged pull-requests** (all merged pull-requests) - **Bug-fixes** (by label `bug` in issue) - **Enhancements** (by label `enhancement` in issue) - -- Excluding "questions" from changelog (issues marked as `question` labels) + - Excluding "questions" from changelog (issues marked as `question` labels) - Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version - Ability to exclude some issues from changelog (by labels) @@ -100,22 +104,16 @@ So, if you got error like this: It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP. -## Examples: - -- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for **this** project -- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command: - - github_changelog_generator -u skywinder -p ActionSheetPicker-3.0 - - ## Projects using this library [Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) -*If you are using `github_changelog_generator` for generation chamgelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.* +*If you are using `github_changelog_generator` for generation changelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.* ## Am I missed some essential feature? -**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! +**Nothing is impossible!** + +Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! *Bug reports, feature requests, patches, well-wishes are always welcome!* @@ -130,8 +128,4 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte ## License -Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT). - - -[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/skywinder/github-changelog-generator/trend.png)](https://bitdeli.com/free "Bitdeli Badge") - +Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT). \ No newline at end of file