Compare commits

...

77 Commits

Author SHA1 Message Date
Petr Korolev
670ced30e3 Merge branch 'release/1.10.0' 2016-01-05 16:44:48 +02:00
Petr Korolev
af97beeb60 Update gemspec to version 1.10.0 2016-01-05 16:44:45 +02:00
Petr Korolev
384b080ad0 Merge pull request #305 from SteveGilvarry/Add_Release_Branch
Fixes #280 Add release-branch option to filter the Pull Requests
2016-01-05 16:43:43 +02:00
Steve Gilvarry
0e4c775ce4 Revert changes made for trying to use github_options
Reverting other changes made that I missed.
2016-01-05 21:31:38 +11:00
Steve Gilvarry
c6eac743b6 Merge pull request #1 from skywinder/SteveGilvarry-Add_Release_Branch
Steve gilvarry add release branch
2016-01-05 21:04:31 +11:00
Petr Korolev
033c7e8d79 Merge branch 'develop' 2016-01-05 12:01:40 +02:00
Petr Korolev
bffe7cd9ff issue 20 in test repo didn't appear in change log. 2016-01-05 11:28:44 +02:00
Petr Korolev
9832dce93c works! 2016-01-05 11:18:04 +02:00
Petr Korolev
d2fa9d3565 Merge branch 'develop' into SteveGilvarry-Add_Release_Branch 2016-01-05 11:07:44 +02:00
Petr Korolev
8f7af37d1e update changelog 2016-01-05 11:04:18 +02:00
Steve Gilvarry
12bc3550e1 Fix Trailing Whitespace error
Rubocop was stopping this from building on Travis.
2016-01-03 07:11:49 +11:00
Steve Gilvarry
5d5a48e00e Remove debug code 2016-01-03 07:06:25 +11:00
Steve Gilvarry
35b581240f Reinstate User and Repo options
Trying to use github options to hold repo and user didn’t seem to work
for all commands. Reverting those changes
2016-01-03 07:02:19 +11:00
Steve Gilvarry
01a0c05a02 Merge remote-tracking branch 'skywinder/master' into Add_Release_Branch 2016-01-02 21:23:37 +11:00
Petr Korolev
90ea75c471 Merge branch 'master' into develop 2015-11-22 11:03:09 +02:00
Petr Korolev
46aaa5f205 Merge pull request #306 from SteveGilvarry/patch-1
Update bundler
2015-11-22 11:02:23 +02:00
Petr Korolev
95d32abbcb Move from legacy code 2015-11-22 10:55:24 +02:00
Petr Korolev
47c0332b55 Merge branch 'master' into develop 2015-11-22 10:48:55 +02:00
Steve Gilvarry
c63b2e1fb9 Update bundler
Standard Bundler in Travis is old and causes build issues, well that is the theory. This will update bundler.

https://github.com/travis-ci/travis-ci/issues/3531
2015-11-20 23:13:31 +11:00
Steve Gilvarry
29fd202ed0 Clean up user and project from all api calls 2015-11-20 22:17:10 +11:00
Steve Gilvarry
fc1fb2eb9a Merge remote-tracking branch 'skywinder/master' into Add_Release_Branch 2015-11-20 22:12:14 +11:00
Steve Gilvarry
afbb47ecf3 Remove repeated user and repo params
Used the github_options setting to add user and repo values
2015-11-20 22:12:06 +11:00
Steve Gilvarry
1d1965e7fb Swap unless nil? to if 2015-11-19 20:14:04 +11:00
Steve Gilvarry
06a8fe8169 Add release-branch option to filter the Pull Requests by those applied on a partcular release branch 2015-11-18 16:56:27 +11:00
Olle Jonsson
138abfe676 Merge pull request #303 from SteveGilvarry/Missing_options_param
Add options to def self.user_and_project_from_git to fix parser.rb:19…
2015-11-11 22:47:01 +01:00
Steve Gilvarry
3fdf0c64df Add options to def self.user_and_project_from_git to fix parser.rb:193 wrong number of arguments (1 for 0) 2015-11-12 07:55:54 +11:00
Petr Korolev
645f96ace6 Merge pull request #298 from olleolleolle/refactor/reader-positive-boolean
[refactor] Reader: positive Boolean; unused #map
2015-10-23 16:49:36 +03:00
Petr Korolev
dfdeb0e633 Merge pull request #299 from olleolleolle/fix/reader-doc-comment
[refactor] Fix docblock datatype, use #map
2015-10-23 16:48:49 +03:00
Petr Korolev
8d44b16e73 Merge pull request #300 from olleolleolle/fix/ignore-coverage-files
Git ignore coverage/
2015-10-23 16:44:57 +03:00
Olle Jonsson
a6e6363cdd Git ignore coverage/ 2015-10-23 08:19:56 +02:00
Olle Jonsson
dd0d82ab91 [refactor] Fix YARD datatype, use #map 2015-10-23 07:44:20 +02:00
Olle Jonsson
8a87be8f4e Reader: use positive Boolean, drop unused #map 2015-10-23 07:32:52 +02:00
Petr Korolev
8f78bb0cc6 Merge pull request #296 from olleolleolle/feature/introduce-parsererror-class
Introduce ParserError exception class
2015-10-22 15:25:54 +03:00
Petr Korolev
b1d2b7d828 Merge pull request #297 from olleolleolle/feature/linting-parser-setup
Rubocop: less complex methods in parser.rb
2015-10-22 15:24:47 +03:00
Olle Jonsson
3fb75c825f Lint: rename to avoid getter naming
- fixed Rake task, too
2015-10-22 00:09:25 +02:00
Olle Jonsson
d227464c33 Rubocop: less complex methods
- Changed one thing: failed return value on printing the banner when
    no user or project was found.
2015-10-21 23:42:33 +02:00
Olle Jonsson
5a9928c18a Introduce ParserError exception class 2015-10-21 23:13:42 +02:00
Petr Korolev
2dda090e6b Merge pull request #295 from jjasghar/patch-1
Update README.md
2015-10-21 22:48:32 +03:00
JJ Asghar
38ddf055ae Update README.md
Typo.
2015-10-21 13:27:17 -05:00
Olle Jonsson
92ade3a625 Merge pull request #290 from olivierlacan/patch-1
keepachangelog.com is not copyrighted ;-)
2015-10-06 22:36:32 +02:00
Olivier Lacan
3d1789a2d1 keepachangelog.com is not copyrighted ;-)
I don't want to suggest that it's copyrighted in any way.
2015-10-06 16:24:58 -04:00
Petr Korolev
4f64cdb7d5 Merge branch 'master' into develop 2015-10-01 19:36:41 +03:00
Olle Jonsson
99ffa3692b Merge pull request #287 from jkeiser/base-option
Add base option to RakeTask
2015-10-01 00:42:00 +02:00
John Keiser
fdb89ea805 Add base option to RakeTask 2015-09-30 11:28:21 -07:00
Olle Jonsson
b7fff7b764 Merge pull request #285 from olleolleolle/feature/specs-simpler
ParserFile: support values with equals signs
2015-09-22 22:07:20 +02:00
Olle Jonsson
6d36d007ad ParserFile: support values with equals signs 2015-09-22 21:59:24 +02:00
Petr Korolev
9dea79fe40 Merge branch 'hotfix/update-changelog' into develop 2015-09-17 12:01:55 +03:00
Petr Korolev
693f5ee2ee Merge branch 'hotfix/update-changelog' 2015-09-17 12:01:54 +03:00
Petr Korolev
e6eb9f5bb6 gemfile lock update 2015-09-17 12:01:40 +03:00
Petr Korolev
916df554af Update changelog for version 1.9.0 2015-09-17 12:00:23 +03:00
Petr Korolev
d959639e2a Merge branch 'release/1.9.0' into develop 2015-09-17 11:59:34 +03:00
Petr Korolev
8f61c7fc7e Merge branch 'release/1.9.0' 2015-09-17 11:59:33 +03:00
Petr Korolev
d79e70b267 Update gemspec to version 1.9.0 2015-09-17 11:59:30 +03:00
Dlani Mendes
ba7c565374 Rspec and README 2015-09-17 11:59:02 +03:00
Petr Korolev
31b4294ed6 rubocop autofix 2015-09-17 11:59:02 +03:00
Petr Korolev
55a1c6933c add build status 2015-09-17 11:59:01 +03:00
Petr Korolev
125960a3a3 run bundle install --no-deploymeng 2015-09-17 11:59:01 +03:00
Petr Korolev
9feecf98b8 update travis 2015-09-17 11:59:01 +03:00
Petr Korolev
4b88f02f97 remove trailing spaces 2015-09-17 11:59:01 +03:00
Olle Jonsson
eccecd6875 Feature: exclude_tags using regular expression 2015-09-17 11:59:01 +03:00
Dlani Mendes
0862e54f42 Auto parse options from file .github_changelog_generator 2015-09-17 11:59:01 +03:00
Petr Korolev
1c578fec91 rm build status 2015-09-17 11:59:01 +03:00
Petr Korolev
29c33fec60 Merge pull request #278 from dlanileonardo/master
Auto parse options from file .github_changelog_generator
2015-09-17 11:58:29 +03:00
Dlani Mendes
6c71cf439a Rspec and README 2015-09-16 16:19:40 -03:00
Petr Korolev
2d7f6bf174 rubocop autofix 2015-09-16 14:50:21 +03:00
Petr Korolev
1e4a3db0a2 Merge pull request #281 from olleolleolle/feature/rake-specs
Feature: exclude_tags using regular expression
2015-09-16 12:14:19 +03:00
Petr Korolev
b0fc03f38c add build status 2015-09-16 10:58:24 +03:00
Petr Korolev
a2658f9af9 run bundle install --no-deploymeng 2015-09-16 10:22:07 +03:00
Petr Korolev
48a49a67ec update travis 2015-09-16 10:09:27 +03:00
Petr Korolev
93b69a511f remove trailing spaces 2015-09-16 09:28:43 +03:00
Olle Jonsson
ef97e7f950 Feature: exclude_tags using regular expression 2015-09-15 21:34:54 +02:00
Dlani Mendes
fbd8207ff4 Auto parse options from file .github_changelog_generator 2015-09-15 13:58:23 -03:00
Petr Korolev
ff4e5612af rm build status 2015-09-15 09:07:46 +03:00
Petr Korolev
6bace8a582 Merge branch 'hotfix/update-changelog' into develop 2015-09-15 09:06:55 +03:00
Petr Korolev
a6b0d0cb83 Merge branch 'hotfix/update-changelog' 2015-09-15 09:06:54 +03:00
Petr Korolev
91176e9174 Update changelog for version 1.8.5 2015-09-15 09:06:52 +03:00
Petr Korolev
494c8afff0 Merge branch 'release/1.8.5' into develop 2015-09-15 09:06:03 +03:00
21 changed files with 270 additions and 147 deletions

1
.gitignore vendored
View File

@@ -0,0 +1 @@
coverage/

View File

@@ -1,6 +1,8 @@
sudo: false sudo: false
cache: bundler
language: ruby language: ruby
before_install:
- gem update --system
- gem install bundler
rvm: rvm:
- 2.1.0 - 2.1.0
script: script:

View File

@@ -1,5 +1,39 @@
# Change Log # Change Log
## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...HEAD)
**Implemented enhancements:**
- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
**Merged pull requests:**
- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
**Implemented enhancements:**
- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
**Merged pull requests:**
- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01) ## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
@@ -21,6 +55,10 @@
- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270) - Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
**Merged pull requests:**
- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25) ## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)

View File

@@ -1,7 +1,7 @@
PATH PATH
remote: . remote: .
specs: specs:
github_changelog_generator (1.8.1) github_changelog_generator (1.9.0)
colorize (~> 0.7) colorize (~> 0.7)
github_api (~> 0.12) github_api (~> 0.12)

View File

@@ -20,7 +20,7 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
- [Contributing](#contributing) - [Contributing](#contributing)
- [License](#license) - [License](#license)
### Changelog generation has never been so easy: ### Changelog generation has never been so easy:
**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. **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.
@@ -32,7 +32,7 @@ To make it easier for users and contributors to see precisely what notable chang
### *Why should I care?* ### *Why should I care?*
Because software tools are for people. If you dont 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. Because software tools are for people. If you dont 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.
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)* > :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com/)*
## Installation ## Installation
@@ -48,26 +48,26 @@ Because software tools are for people. If you dont care, why are you contribu
- In general it looks like this: - In general it looks like this:
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15) > ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
> >
> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5) > [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
> >
> **Implemented enhancements:** > **Implemented enhancements:**
> >
> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22) > - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
> >
> **Fixed bugs:** > **Fixed bugs:**
> >
> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32) > - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
> >
> **Merged pull requests:** > **Merged pull requests:**
> >
> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing)) > - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
> >
> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett)) > - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
## Usage ## Usage
**It's really simple**: **It's really simple**:
- If your **git remote** `origin` refers 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:
@@ -76,7 +76,7 @@ Because software tools are for people. If you dont care, why are you contribu
- or from anywhere: - or from anywhere:
- `github_changelog_generator -u github_username -p github_project` - `github_changelog_generator -u github_username -p github_project`
- `github_changelog_generator github_username/github_project` - `github_changelog_generator github_username/github_project`
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog. As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
### Params ### Params
@@ -84,6 +84,16 @@ Type `github_changelog_generator --help` for details.
More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples) More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
### Params File
You can put Params in a .github_changelog_generator file in Project Root to override default params:
Example:
```
unreleased=false
future-release=5.0.0
since-tag=1.0.0
```
### GitHub token ### GitHub token
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a 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)
@@ -92,9 +102,9 @@ Since GitHub allows you to make only 50 requests without authentication it's rec
And: And:
- Run with key `-t [your-40-digit-token]` - Run with key `-t [your-40-digit-token]`
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. - Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string : i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token" export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
@@ -107,7 +117,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
## Migrating from a manual changelog ## Migrating from a manual changelog
Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog, Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog,
but you most likely wouln't like to have to open issues and PRs for all past features listed in your historic changelog. but you most likely wouldn't like to have to open issues and PRs for all past features listed in your historic changelog.
That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries. That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
@@ -139,10 +149,10 @@ All command line options can be passed to the Rake task as `config` parameters.
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows: - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
- Bug fixes (by label `bug` in issue) :beetle: - Bug fixes (by label `bug` in issue) :beetle:
- Enhancements (by label `enhancement` in issue) :star2: - 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 can manually 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: - Apply a lot of other customisations, to fit changelog for your personal style :tophat:
(*look `github_changelog_generator --help` for details)* (*look `github_changelog_generator --help` for details)*
@@ -153,7 +163,7 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
### 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) [Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it. If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
@@ -161,9 +171,9 @@ If you've used this project in a live app, please let me know! Nothing makes me
## Am I missing some essential feature? ## Am I missing 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:

View File

@@ -22,6 +22,7 @@
**Merged pull requests:** **Merged pull requests:**
- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder)) - This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder)) - This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder)) - This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))

View File

@@ -7,6 +7,7 @@ require "benchmark"
require_relative "github_changelog_generator/helper" require_relative "github_changelog_generator/helper"
require_relative "github_changelog_generator/parser" require_relative "github_changelog_generator/parser"
require_relative "github_changelog_generator/parser_file"
require_relative "github_changelog_generator/generator/generator" require_relative "github_changelog_generator/generator/generator"
require_relative "github_changelog_generator/version" require_relative "github_changelog_generator/version"
require_relative "github_changelog_generator/reader" require_relative "github_changelog_generator/reader"

View File

@@ -18,12 +18,12 @@ module GitHubChangelogGenerator
@user = @options[:user] @user = @options[:user]
@project = @options[:project] @project = @options[:project]
@github_token = fetch_github_token @github_token = fetch_github_token
github_options = { per_page: PER_PAGE_NUMBER } @github_options = { per_page: PER_PAGE_NUMBER }
github_options[:oauth_token] = @github_token unless @github_token.nil? @github_options[:oauth_token] = @github_token unless @github_token.nil?
github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil? @github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil? @github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
@github = check_github_response { Github.new github_options } @github = check_github_response { Github.new @github_options }
end end
# Returns GitHub token. First try to use variable, provided by --token option, # Returns GitHub token. First try to use variable, provided by --token option,
@@ -123,7 +123,16 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
def fetch_closed_pull_requests def fetch_closed_pull_requests
pull_requests = [] pull_requests = []
begin begin
response = @github.pull_requests.list @options[:user], @options[:project], state: "closed" if @options[:release_branch].nil?
response = @github.pull_requests.list @options[:user],
@options[:project],
state: "closed"
else
response = @github.pull_requests.list @options[:user],
@options[:project],
state: "closed",
base: @options[:release_branch]
end
page_i = 0 page_i = 0
count_pages = response.count_pages count_pages = response.count_pages
response.each_page do |page| response.each_page do |page|

View File

@@ -178,8 +178,10 @@ module GitHubChangelogGenerator
fetched_pr = closed_pull_requests.find do |fpr| fetched_pr = closed_pull_requests.find do |fpr|
fpr.number == pr.number fpr.number == pr.number
end end
pr[:merged_at] = fetched_pr[:merged_at] if fetched_pr
closed_pull_requests.delete(fetched_pr) pr[:merged_at] = fetched_pr[:merged_at]
closed_pull_requests.delete(fetched_pr)
end
end end
pull_requests.select! do |pr| pull_requests.select! do |pr|

View File

@@ -131,16 +131,45 @@ module GitHubChangelogGenerator
# @param [Array] all_tags all tags # @param [Array] all_tags all tags
# @return [Array] filtered tags according :exclude_tags option # @return [Array] filtered tags according :exclude_tags option
def filter_excluded_tags(all_tags) def filter_excluded_tags(all_tags)
filtered_tags = all_tags return all_tags unless @options[:exclude_tags]
if @options[:exclude_tags]
@options[:exclude_tags].each do |tag| apply_exclude_tags(all_tags)
unless all_tags.map(&:name).include? tag end
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
end private
end
filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name } def apply_exclude_tags(all_tags)
if @options[:exclude_tags].is_a?(Regexp)
filter_tags_with_regex(all_tags)
else
filter_exact_tags(all_tags)
end
end
def filter_tags_with_regex(all_tags)
warn_if_nonmatching_regex(all_tags)
all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
end
def filter_exact_tags(all_tags)
@options[:exclude_tags].each do |tag|
warn_if_tag_not_found(all_tags, tag)
end
all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
end
def warn_if_nonmatching_regex(all_tags)
unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
Helper.log.warn "Warning: unable to reject any tag, using regex "\
"#{@options[:exclude_tags].inspect} in --exclude-tags "\
"option."
end
end
def warn_if_tag_not_found(all_tags, tag)
unless all_tags.map(&:name).include? tag
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
end end
filtered_tags
end end
end end
end end

View File

@@ -7,20 +7,16 @@ module GitHubChangelogGenerator
class Parser class Parser
# parse options with optparse # parse options with optparse
def self.parse_options def self.parse_options
options = get_default_options options = default_options
ParserFile.new(options).parse!
parser = setup_parser(options) parser = setup_parser(options)
parser.parse! parser.parse!
if options[:user].nil? || options[:project].nil? user_and_project_from_git(options)
detect_user_and_project(options, ARGV[0], ARGV[1])
end
if !options[:user] || !options[:project] abort(parser.banner) unless options[:user] && options[:project]
puts parser.banner
exit
end
print_options(options) print_options(options)
@@ -147,6 +143,9 @@ module GitHubChangelogGenerator
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release| opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
options[:future_release] = future_release options[:future_release] = future_release
end end
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
options[:release_branch] = release_branch
end
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v| opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
options[:verbose] = v options[:verbose] = v
end end
@@ -163,8 +162,8 @@ module GitHubChangelogGenerator
end end
# just get default options # just get default options
def self.get_default_options def self.default_options
options = { {
tag1: nil, tag1: nil,
tag2: nil, tag2: nil,
date_format: "%Y-%m-%d", date_format: "%Y-%m-%d",
@@ -192,21 +191,25 @@ module GitHubChangelogGenerator
enhancement_prefix: "**Implemented enhancements:**", enhancement_prefix: "**Implemented enhancements:**",
git_remote: "origin" git_remote: "origin"
} }
end
options def self.user_and_project_from_git(options)
if options[:user].nil? || options[:project].nil?
detect_user_and_project(options, ARGV[0], ARGV[1])
end
end end
# Detects user and project from git # Detects user and project from git
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil) def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site]) options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
if !options[:user] || !options[:project] return if options[:user] && options[:project]
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
options[:user] = "skywinder" if ENV["RUBYLIB"] =~ /ruby-debug-ide/
options[:project] = "changelog_test" options[:user] = "skywinder"
else options[:project] = "changelog_test"
remote = `git config --get remote.#{options[:git_remote]}.url` else
options[:user], options[:project] = user_project_from_remote(remote) remote = `git config --get remote.#{options[:git_remote]}.url`
end options[:user], options[:project] = user_project_from_remote(remote)
end end
end end

View File

@@ -0,0 +1,39 @@
module GitHubChangelogGenerator
ParserError = Class.new(StandardError)
class ParserFile
def initialize(options)
@options = options
end
def parse!
return unless File.exist?(file)
File.readlines(file).each { |line| parse_line!(line) }
end
private
def file
@file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
end
def parse_line!(line)
key_sym, value = extract_pair(line)
value = true if value =~ (/^(true|t|yes|y|1)$/i)
value = false if value =~ (/^(false|f|no|n|0)$/i)
@options[key_sym] = value
rescue
raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
end
# Returns a the setting as a symbol and its string value sans newlines.
#
# @param line [String] unparsed line from config file
# @return [Array<Symbol, String>]
def extract_pair(line)
key, value = line.split("=", 2)
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
end
end
end

View File

@@ -53,31 +53,28 @@ module GitHubChangelogGenerator
@heading_structures.each do |regexp| @heading_structures.each do |regexp|
matches = Regexp.new(regexp).match(heading) matches = Regexp.new(regexp).match(heading)
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil? if matches
captures.merge!(Hash[matches.names.zip(matches.captures)])
# Try Regular Expressions until you find one that delivers results break
break unless matches.nil? end
end end
captures captures
end end
# Parse the given ChangeLog data into a Hash # Parse the given ChangeLog data into a list of Hashes
# #
# @param [String] data File data from the ChangeLog.md # @param [String] data File data from the ChangeLog.md
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...] # @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
def parse(data) def parse(data)
sections = data.split(/^## .+?$/) sections = data.split(/^## .+?$/)
headings = data.scan(/^## .+?$/) headings = data.scan(/^## .+?$/)
changelog = []
headings.each_with_index do |heading, index| headings.each_with_index.map do |heading, index|
captures = parse_heading(heading) section = parse_heading(heading)
captures["content"] = sections.at(index + 1) section["content"] = sections.at(index + 1)
changelog.push captures section
end end
changelog
end end
def read(file_path) def read(file_path)

View File

@@ -16,7 +16,8 @@ module GitHubChangelogGenerator
bug_labels enhancement_labels bug_labels enhancement_labels
between_tags exclude_tags since_tag max_issues between_tags exclude_tags since_tag max_issues
github_site github_endpoint simple_list github_site github_endpoint simple_list
future_release verbose release_url ) future_release release_branch verbose release_url
base )
OPTIONS.each do |o| OPTIONS.each do |o|
attr_accessor o.to_sym attr_accessor o.to_sym
@@ -43,11 +44,9 @@ module GitHubChangelogGenerator
task @name do task @name do
# mimick parse_options # mimick parse_options
options = Parser.get_default_options options = Parser.default_options
if options[:user].nil? || options[:project].nil? Parser.user_and_project_from_git(options)
Parser.detect_user_and_project(options)
end
OPTIONS.each do |o| OPTIONS.each do |o|
v = instance_variable_get("@#{o}") v = instance_variable_get("@#{o}")

View File

@@ -1,3 +1,3 @@
module GitHubChangelogGenerator module GitHubChangelogGenerator
VERSION = "1.8.5" VERSION = "1.10.0"
end end

View File

View File

@@ -0,0 +1,2 @@
unreleased_label: staging
unreleased: false

View File

@@ -0,0 +1,3 @@
unreleased_label=staging
unreleased=false
header==== Changelog ===

View File

@@ -31,91 +31,25 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
SimpleCov.start SimpleCov.start
require "github_changelog_generator" require "github_changelog_generator"
require "github_changelog_generator/task"
# This file was generated by the `rspec --init` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause
# this file to always be loaded, without a need to explicitly require it in any
# files.
#
# Given that it is always loaded, you are encouraged to keep this file as
# light-weight as possible. Requiring heavyweight dependencies from this file
# will add to the boot time of your test suite on EVERY test run, even for an
# individual file that may not need all of that loaded. Instead, consider making
# a separate helper file that requires the additional dependencies and performs
# the additional setup, and require it from the spec files that actually need
# it.
#
# The `.rspec` file also contains a few flags that are not defaults but that
# users commonly want.
#
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
RSpec.configure do |config| RSpec.configure do |config|
# rspec-expectations config goes here. You can use an alternate
# assertion/expectation library such as wrong or the stdlib/minitest
# assertions if you prefer.
config.expect_with :rspec do |expectations| config.expect_with :rspec do |expectations|
# This option will default to `true` in RSpec 4. It makes the `description`
# and `failure_message` of custom matchers include text for helper methods
# defined using `chain`, e.g.:
# be_bigger_than(2).and_smaller_than(4).description
# # => "be bigger than 2 and smaller than 4"
# ...rather than:
# # => "be bigger than 2"
expectations.include_chain_clauses_in_custom_matcher_descriptions = true expectations.include_chain_clauses_in_custom_matcher_descriptions = true
end end
# rspec-mocks config goes here. You can use an alternate test double
# library (such as bogus or mocha) by changing the `mock_with` option here.
config.mock_with :rspec do |mocks| config.mock_with :rspec do |mocks|
# Prevents you from mocking or stubbing a method that does not exist on
# a real object. This is generally recommended, and will default to
# `true` in RSpec 4.
mocks.verify_partial_doubles = true mocks.verify_partial_doubles = true
end end
# These two settings work together to allow you to limit a spec run
# to individual examples or groups you care about by tagging them with
# `:focus` metadata. When nothing is tagged with `:focus`, all examples
# get run.
config.filter_run :focus config.filter_run :focus
config.run_all_when_everything_filtered = true config.run_all_when_everything_filtered = true
# Limits the available syntax to the non-monkey patched syntax that is
# recommended. For more details, see:
# - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
# - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
# - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
# config.disable_monkey_patching!
# This setting enables warnings. It's recommended, but in some cases may
# be too noisy due to issues in dependencies.
config.warnings = true config.warnings = true
# Many RSpec users commonly either run the entire suite or an individual config.default_formatter = "doc" if config.files_to_run.one?
# file, and it's useful to allow more verbose output when running an
# individual spec file.
if config.files_to_run.one?
# Use the documentation formatter for detailed output,
# unless a formatter has already been configured
# (e.g. via a command-line flag).
config.default_formatter = "doc"
end
# Print the 10 slowest examples and example groups at the
# end of the spec run, to help surface which specs are running
# particularly slow.
# config.profile_examples = 10
# Run specs in random order to surface order dependencies. If you find an
# order dependency and want to debug it, you can fix the order by providing
# the seed, which is printed after each run.
# --seed 1234
config.order = :random config.order = :random
# Seed global randomization in this process using the `--seed` CLI option.
# Setting this allows you to use `--seed` to deterministically reproduce
# test failures related to randomization by passing the same `--seed` value
# as the one that triggered the failure.
Kernel.srand config.seed Kernel.srand config.seed
end end

View File

@@ -87,6 +87,18 @@ describe GitHubChangelogGenerator::Generator do
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) } it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end end
context "with regex exclude_tags" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
end
context "with non-matching regex in exclude_tags" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end
end end
describe "#filter_since_tag" do describe "#filter_since_tag" do

View File

@@ -0,0 +1,41 @@
describe GitHubChangelogGenerator::ParserFile do
describe ".github_changelog_generator" do
context "when no has file" do
let(:options) { {} }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
subject { parse.parse! }
it { is_expected.to be_nil }
end
context "when file is empty" do
let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it "does not change the options" do
expect { parse.parse! }.to_not change { options }
end
end
context "when file is incorrect" do
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
end
context "when override default values" do
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it "changes the options" do
expect { parse.parse! }.to change { options }
.from(options_before_change)
.to(options_before_change.merge(unreleased_label: "staging",
unreleased: false,
header: "=== Changelog ==="))
end
end
end
end