From 70e8c287f523203b28ddf85c5d2f19b455270ba2 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:36:01 +0200 Subject: [PATCH 01/14] update readme --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d3b3c6e..d17b486 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ Type `github_changelog_generator --help` for detailed usage. ### GitHub token -Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token +Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token (`-t, --token` option) **You can easily [generate it here](https://github.com/settings/applications)**. @@ -121,13 +121,13 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte ##Features and advantages of this project - Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem: -- Possible to generate **Unreleased** changes (closed issues that have not released yet) -- **GitHub Enterprise support** via command line options! +- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy: +- **GitHub Enterprise support** via command line options! :factory: - Flexible format **customisation**: - - **Customize** issues, that **should be added** to changelog - - **Custom date format** supported + - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk: + - **Custom date format** supported :date: - 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 specific issues** from change log (by labels) + - Ability to **exclude specific issues** from change log (by labels) :negative_squared_cross_mark: - **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) :scissors: - **Distinguish** bug fixes, enchantments, and closed issues **according labels**. - Merged pull-requests (all merged pull-requests) @@ -152,9 +152,9 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch **Nothing is impossible!** -Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! +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!* +*Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark: ## Contributing @@ -164,6 +164,7 @@ Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/n 4. Commit your changes (`git commit -am 'Add some feature'`) 5. Push to the branch (`git push origin my-new-feature`) 6. Create a new Pull Request +7. Profit! :white_check_mark: ## License From a1b19044c266d54a5112b3d956bc49350b7c6341 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:43:11 +0200 Subject: [PATCH 02/14] update --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d17b486..5fd63b9 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ GitHub Changelog Generator **Fully automate changelog generation** - This gem generate change log file based on **tags**, **issues** and merged **pull requests** (and split them to separate lists according labels) from :octocat: GitHub Issue Tracker. -Since now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release! +Since now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release! :tada: ### *What’s the point of a change log?* To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. @@ -129,11 +129,11 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - 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 specific issues** from change log (by labels) :negative_squared_cross_mark: - **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) :scissors: -- **Distinguish** bug fixes, enchantments, and closed issues **according labels**. - - Merged pull-requests (all merged pull-requests) - - Bug-fixes (by label `bug` in issue) - - Enhancements (by label `enhancement` in issue) - - Issues (closed issues w/o any labels) +- **Distinguish** bug fixes, enchantments, and closed issues **according labels**. :mag_right: + - Merged pull-requests (all merged pull-requests) :twisted_rightwards_arrows: + - Bug-fixes (by label `bug` in issue) :beetle: + - Enhancements (by label `enhancement` in issue) :star2: + - Issues (closed issues w/o any labels) :non-potable_water: - You manualy can set which labels should be included/excluded and apply a lot of other customisations, to fit changelog for your personal style :tophat: (*look `github_changelog_generator --help` for details)* From 432f12af70b2bc8290c71a46e6ab22a02b58f152 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:45:51 +0200 Subject: [PATCH 03/14] update --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fd63b9..5739fc7 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,9 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - Bug-fixes (by label `bug` in issue) :beetle: - Enhancements (by label `enhancement` in issue) :star2: - Issues (closed issues w/o any labels) :non-potable_water: -- You manualy can set which labels should be included/excluded and apply a lot of other customisations, to fit changelog for your personal style :tophat: (*look `github_changelog_generator --help` for details)* +- You manually can set which labels should be included/excluded. :wrench: +- Apply a lot of other customisations, to fit changelog for your personal style :tophat: +(*look `github_changelog_generator --help` for details)* ###Alternatives From 79f16947b7370a48c143fd8a771ec762dfe17be1 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:52:46 +0200 Subject: [PATCH 04/14] update --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5739fc7..31f27c5 100644 --- a/README.md +++ b/README.md @@ -129,11 +129,13 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - 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 specific issues** from change log (by labels) :negative_squared_cross_mark: - **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) :scissors: -- **Distinguish** bug fixes, enchantments, and closed issues **according labels**. :mag_right: - - Merged pull-requests (all merged pull-requests) :twisted_rightwards_arrows: - - Bug-fixes (by label `bug` in issue) :beetle: + +- **Distinguish** issues **according labels**. :mag_right: + - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows: + - Bug fixes (by label `bug` in issue) :beetle: - Enhancements (by label `enhancement` in issue) :star2: - - Issues (closed issues w/o any labels) :non-potable_water: + - Issues (closed issues `w/o any labels`) :non-potable_water: + - You manually can set which labels should be included/excluded. :wrench: - Apply a lot of other customisations, to fit changelog for your personal style :tophat: (*look `github_changelog_generator --help` for details)* From 165e8d4e9fdb9b487c92d2548d16a1e80f698215 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:56:35 +0200 Subject: [PATCH 05/14] update --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 31f27c5..a6c4bb7 100644 --- a/README.md +++ b/README.md @@ -126,10 +126,8 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - Flexible format **customisation**: - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk: - **Custom date format** supported :date: - - 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 specific issues** from change log (by labels) :negative_squared_cross_mark: - - **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) :scissors: - + - 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 :pushpin: + - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors: - **Distinguish** issues **according labels**. :mag_right: - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows: - Bug fixes (by label `bug` in issue) :beetle: From e51bceda05faf430277b7d0fe8ba2687d900e1f6 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:59:44 +0200 Subject: [PATCH 06/14] upate --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6c4bb7..0f691a6 100644 --- a/README.md +++ b/README.md @@ -152,11 +152,11 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch ## Am I missed some essential feature? -**Nothing is impossible!** +- **Nothing is impossible!** -Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! +- 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* :heavy_exclamation_mark: +- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark: ## Contributing From f6388903b73b639934e4085dec9874e6e877aa74 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 16:04:42 +0200 Subject: [PATCH 07/14] cm --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f691a6..fa9f5d2 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,12 @@ GitHub Changelog Generator Since now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release! :tada: -### *What’s the point of a change log?* +>### *What’s the point of a change log?* To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. +### *Why should I care?* +Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours. + +>(c) *[http://keepachangelog.com](http://keepachangelog.com/)* ## Installation From 2b46ba2a11dd70e15dbbe73d23bbda3900f2515a Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 16:06:27 +0200 Subject: [PATCH 08/14] cm --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fa9f5d2..1bbcb32 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ To make it easier for users and contributors to see precisely what notable chang ### *Why should I care?* Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours. ->(c) *[http://keepachangelog.com](http://keepachangelog.com/)* +> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)* ## Installation From fdcf5ccf7ed69c3634178937fc780c012f19759d Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Fri, 20 Mar 2015 13:05:00 +0200 Subject: [PATCH 09/14] add faq --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 1bbcb32..f5a3227 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,27 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch - *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark: +## FAQ + +- ***I already use GitHub Releases. Why do I need this?*** + +GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations: + +I'm not try to compare quality of auto-generated and manually generated logs. + +The Changelog like this sometimes really helps. For example: + +When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`. + +- it's not so quite easy to find it in manually filled Releases notes. +- this file can also help you to build your Release note and not miss features in manually-filled list. + +In the end: + +I think, that GitHub Releases is more for end-users. +But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes. +And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner. + ## Contributing 1. Create an issue to discuss about your idea From f248e1c718705c157a11208c5f971ee38a8095b7 Mon Sep 17 00:00:00 2001 From: Eric Dill Date: Fri, 20 Mar 2015 09:56:54 -0400 Subject: [PATCH 10/14] MNT: Fix travis badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f5a3227..548836c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator) -[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/skywinder/Github-Changelog-Generator) +[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator) GitHub Changelog Generator ================== From 83e406ca5f07e10c80ef72f40ec3df291c61fa60 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Fri, 20 Mar 2015 18:38:55 +0200 Subject: [PATCH 11/14] ad xkcd link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 548836c..9c2cf09 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - **GitHub Enterprise support** via command line options! :factory: - Flexible format **customisation**: - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk: - - **Custom date format** supported :date: + - **Custom date format** supported (but don't forget about [standards](http://xkcd.com/1179/) :date: - 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 :pushpin: - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors: - **Distinguish** issues **according labels**. :mag_right: From e5f6670a0753636ec1b589859f8c3e56c8d3932c Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Fri, 20 Mar 2015 18:41:55 +0200 Subject: [PATCH 12/14] add link to issue --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c2cf09..3776482 100644 --- a/README.md +++ b/README.md @@ -166,11 +166,15 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch - ***I already use GitHub Releases. Why do I need this?*** -GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations: +GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations: -I'm not try to compare quality of auto-generated and manually generated logs. +*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)* -The Changelog like this sometimes really helps. For example: +I'm not try to compare quality of auto-generated and manually generated logs.. but: + +The auto generated Changelog really helps even if you manually fill Releases notes! + +For example: When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`. From 32149b8a2cdf4a375a6e97b46db7c8ef7c1a0f3b Mon Sep 17 00:00:00 2001 From: brb Date: Fri, 20 Mar 2015 14:28:48 -0700 Subject: [PATCH 13/14] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3776482..e402e17 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,16 @@ GitHub Changelog Generator - [Features and advantages of this project](#features-and-advantages-of-this-project) - [Alternatives](#alternatives) - [Projects using this library](#projects-using-this-library) - - [Am I missed some essential feature?](#am-i-missed-some-essential-feature) + - [Am I missing some essential feature?](#am-i-missing-some-essential-feature) - [Contributing](#contributing) - [License](#license) ### Changelog generation has never been so easy: -**Fully automate changelog generation** - This gem generate change log file based on **tags**, **issues** and merged **pull requests** (and split them to separate lists according labels) from :octocat: GitHub Issue Tracker. +**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker. -Since now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release! :tada: +Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada: >### *What’s the point of a change log?* To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. @@ -66,7 +66,7 @@ Because software tools are for people. If you don’t care, why are you contribu ## Usage **It's really simple**: -- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run: +- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run: github_changelog_generator @@ -105,7 +105,7 @@ Type `github_changelog_generator --help` for detailed usage. ### GitHub token -Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token (`-t, --token` option) +Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option) **You can easily [generate it here](https://github.com/settings/applications)**. @@ -138,13 +138,13 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - Enhancements (by label `enhancement` in issue) :star2: - Issues (closed issues `w/o any labels`) :non-potable_water: -- You manually can set which labels should be included/excluded. :wrench: +- You can manually set which labels should be included/excluded. :wrench: - Apply a lot of other customisations, to fit changelog for your personal style :tophat: (*look `github_changelog_generator --help` for details)* ###Alternatives -Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But no one was satisfy my requirements. +Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements. *If you know other projects - feel free to edit this Wiki page!* @@ -154,7 +154,7 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch *If you are using `github_changelog_generator` for generation change log in your project or know another 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? +## Am I missing some essential feature? - **Nothing is impossible!** From dbb385d049735cc56fe04221c2bd9b40813d8b62 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Fri, 20 Mar 2015 23:44:18 +0200 Subject: [PATCH 14/14] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e402e17..5e9f955 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - **GitHub Enterprise support** via command line options! :factory: - Flexible format **customisation**: - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk: - - **Custom date format** supported (but don't forget about [standards](http://xkcd.com/1179/) :date: + - **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date: - 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 :pushpin: - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors: - **Distinguish** issues **according labels**. :mag_right: