From 31137c2ca4d18defa7f008bbc6d729133486b2c6 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Feb 2015 20:20:57 +0200 Subject: [PATCH 1/4] update readme --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 99c0af0..642984f 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ GitHub Changelog Generator ================== - - [Installation:](#installation) - - [Output example:](#output-example) - - [Usage:](#usage) - - [Params:](#params) + - [Installation](#installation) + - [Output example](#output-example) + - [Usage](#usage) + - [Params](#params) - [GitHub token](#github-token) - - [Features and advantages of this project as compared to other:](#features-and-advantages-of-this-project-as-compared-to-other) - - [Alternatives:](#alternatives) - - [Projects using this library:](#projects-using-this-library) + - [Features and advantages of this project as compared to other](#features-and-advantages-of-this-project-as-compared-to-other) + - [Alternatives](#alternatives) + - [Projects using this library](#projects-using-this-library) - [Am I missed some essential feature?](#am-i-missed-some-essential-feature) - [Contributing](#contributing) - [License](#license) @@ -22,11 +22,11 @@ Changelog generation has never been so easy. **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: +## Installation [sudo] gem install github_changelog_generator -## Output 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: @@ -54,7 +54,7 @@ Changelog generation has never been so easy. > - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122) -## 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: @@ -67,7 +67,7 @@ Changelog generation has never been so easy. As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog. -### Params: +### Params Type `github_changelog_generator --help` for detailed usage. Usage: changelog_generator [options] @@ -107,8 +107,8 @@ 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. -##Features and advantages of this project as compared to other: -- Automatically split issues by type: +##Features and advantages of this project as compared to other +- 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) @@ -118,13 +118,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 changelog (by labels) -###Alternatives: +###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. *If you know other projects - feel free to edit this Wiki page!* -### Projects using this library: +### 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 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.* From a1618367f126ef808af52d504c11bdd1a7987460 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Feb 2015 23:39:28 +0200 Subject: [PATCH 2/4] update changelog --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3514157..2142208 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ - *Merged pull-request:* Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder)) +- *Implemented enhancement:* Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52) + +- *Implemented enhancement:* Not Released [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47) + +- *Fixed bug:* Test pull request with invalid label \(#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44) + ## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8) From b107671a665c3784c60eca725fa0a43259f93a4e Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Thu, 19 Feb 2015 00:05:02 +0200 Subject: [PATCH 3/4] Update readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 642984f..95c5f48 100644 --- a/README.md +++ b/README.md @@ -108,15 +108,18 @@ 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. ##Features and advantages of this project as compared to other +- Generate cannonical changelog file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/) +- Support **Unreleased** issues (closed issues that have not yet released) +- Customize issues, that should be added to changelog +- Custom date format supported +- 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 changelog (by labels) + - Automatically exclude "questions" - issues marked as `question` labels (and other issues, that should'n be in changelog file: with `duplicate invalid wontfix` labels) - 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) -- Custom date format supported -- 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 changelog (by labels) ###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. From cd5aa7be1c79aa9e298534b59de336dc1250ec59 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Mon, 23 Feb 2015 12:35:12 +0200 Subject: [PATCH 4/4] update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 95c5f48..8c2c62b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ GitHub Changelog Generator - [Usage](#usage) - [Params](#params) - [GitHub token](#github-token) - - [Features and advantages of this project as compared to other](#features-and-advantages-of-this-project-as-compared-to-other) + - [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) @@ -107,7 +107,7 @@ 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. -##Features and advantages of this project as compared to other +##Features and advantages of this project - Generate cannonical changelog file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/) - Support **Unreleased** issues (closed issues that have not yet released) - Customize issues, that should be added to changelog