Compare commits
3 Commits
1.8.3
...
feature/fi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d4664e389d | ||
|
|
0e352886ea | ||
|
|
01e30d1132 |
@@ -6,11 +6,3 @@ Metrics/LineLength:
|
|||||||
#http://viget.com/extend/just-use-double-quoted-ruby-strings
|
#http://viget.com/extend/just-use-double-quoted-ruby-strings
|
||||||
Style/StringLiterals:
|
Style/StringLiterals:
|
||||||
EnforcedStyle: double_quotes
|
EnforcedStyle: double_quotes
|
||||||
|
|
||||||
# Configuration parameters: CountComments.
|
|
||||||
Metrics/ClassLength:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Configuration parameters: CountComments.
|
|
||||||
Metrics/MethodLength:
|
|
||||||
Enabled: false
|
|
||||||
|
|||||||
@@ -1,18 +1,28 @@
|
|||||||
# This configuration was generated by `rubocop --auto-gen-config`
|
# This configuration was generated by `rubocop --auto-gen-config`
|
||||||
# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
|
# on 2015-05-25 17:16:04 +0300 using RuboCop version 0.31.0.
|
||||||
# The point is for the user to remove these configuration records
|
# The point is for the user to remove these configuration records
|
||||||
# one by one as the offenses are removed from the code base.
|
# one by one as the offenses are removed from the code base.
|
||||||
# Note that changes in the inspected code, or installation of new
|
# Note that changes in the inspected code, or installation of new
|
||||||
# versions of RuboCop, may require this file to be generated again.
|
# versions of RuboCop, may require this file to be generated again.
|
||||||
|
|
||||||
# Offense count: 13
|
# Offense count: 14
|
||||||
Metrics/AbcSize:
|
Metrics/AbcSize:
|
||||||
Enabled: false
|
Max: 57
|
||||||
|
|
||||||
|
# Offense count: 4
|
||||||
|
# Configuration parameters: CountComments.
|
||||||
|
Metrics/ClassLength:
|
||||||
|
Max: 182
|
||||||
|
|
||||||
# Offense count: 1
|
# Offense count: 1
|
||||||
Metrics/CyclomaticComplexity:
|
Metrics/CyclomaticComplexity:
|
||||||
Max: 7
|
Max: 7
|
||||||
|
|
||||||
|
# Offense count: 22
|
||||||
|
# Configuration parameters: CountComments.
|
||||||
|
Metrics/MethodLength:
|
||||||
|
Max: 84
|
||||||
|
|
||||||
# Offense count: 1
|
# Offense count: 1
|
||||||
Metrics/PerceivedComplexity:
|
Metrics/PerceivedComplexity:
|
||||||
Max: 8
|
Max: 8
|
||||||
@@ -21,7 +31,7 @@ Metrics/PerceivedComplexity:
|
|||||||
Style/AccessorMethodName:
|
Style/AccessorMethodName:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
# Offense count: 10
|
# Offense count: 8
|
||||||
Style/Documentation:
|
Style/Documentation:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
|
|||||||
161
CHANGELOG.md
161
CHANGELOG.md
@@ -1,94 +1,7 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
|
|
||||||
|
|
||||||
## [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)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
|
|
||||||
- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
|
|
||||||
- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
|
|
||||||
- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
|
|
||||||
- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
|
|
||||||
- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
|
|
||||||
- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Custom header [\#251](https://github.com/skywinder/github-changelog-generator/issues/251)
|
|
||||||
- Arbitrary templates [\#242](https://github.com/skywinder/github-changelog-generator/issues/242)
|
|
||||||
|
|
||||||
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250)
|
|
||||||
|
|
||||||
## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Ability to specify custom section header [\#241](https://github.com/skywinder/github-changelog-generator/issues/241)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249)
|
|
||||||
|
|
||||||
## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Issues with any label except "bug", "enhancement" should not be excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240)
|
|
||||||
- Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246)
|
|
||||||
- Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245)
|
|
||||||
|
|
||||||
## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.1...1.5.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
|
|
||||||
- Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
|
|
||||||
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
|
|
||||||
- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
|
## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
@@ -98,23 +11,28 @@
|
|||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237)
|
- github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237)
|
||||||
|
|
||||||
- Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235)
|
- Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235)
|
||||||
|
|
||||||
- Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69)
|
- Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder))
|
- Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder))
|
- Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur))
|
- Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur))
|
||||||
|
|
||||||
## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
|
## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
|
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
|
||||||
|
|
||||||
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
|
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
|
||||||
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
|
||||||
|
|
||||||
**Closed issues:**
|
**Closed issues:**
|
||||||
|
|
||||||
@@ -122,14 +40,22 @@
|
|||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
||||||
|
|
||||||
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
|
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
|
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
||||||
|
|
||||||
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
|
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
|
||||||
|
|
||||||
- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
|
- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
|
||||||
|
|
||||||
## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
|
## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
@@ -137,30 +63,35 @@
|
|||||||
- Add fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder))
|
- Add fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
|
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
|
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.3.9](https://github.com/skywinder/github-changelog-generator/tree/1.3.9) (2015-03-06)
|
## [1.3.9](https://github.com/skywinder/github-changelog-generator/tree/1.3.9) (2015-03-06)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
|
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
|
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.3.8](https://github.com/skywinder/github-changelog-generator/tree/1.3.8) (2015-03-05)
|
## [1.3.8](https://github.com/skywinder/github-changelog-generator/tree/1.3.8) (2015-03-05)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8)
|
||||||
|
|
||||||
## [1.3.6](https://github.com/skywinder/github-changelog-generator/tree/1.3.6) (2015-03-05)
|
## [1.3.6](https://github.com/skywinder/github-changelog-generator/tree/1.3.6) (2015-03-05)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6)
|
||||||
|
|
||||||
## [1.3.5](https://github.com/skywinder/github-changelog-generator/tree/1.3.5) (2015-03-04)
|
## [1.3.5](https://github.com/skywinder/github-changelog-generator/tree/1.3.5) (2015-03-04)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.4...1.3.5)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.4...1.3.5)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
@@ -168,6 +99,7 @@
|
|||||||
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/github-changelog-generator/issues/60)
|
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/github-changelog-generator/issues/60)
|
||||||
|
|
||||||
## [1.3.4](https://github.com/skywinder/github-changelog-generator/tree/1.3.4) (2015-03-03)
|
## [1.3.4](https://github.com/skywinder/github-changelog-generator/tree/1.3.4) (2015-03-03)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
@@ -175,6 +107,7 @@
|
|||||||
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/github-changelog-generator/issues/59)
|
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/github-changelog-generator/issues/59)
|
||||||
|
|
||||||
## [1.3.3](https://github.com/skywinder/github-changelog-generator/tree/1.3.3) (2015-03-03)
|
## [1.3.3](https://github.com/skywinder/github-changelog-generator/tree/1.3.3) (2015-03-03)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3)
|
||||||
|
|
||||||
**Closed issues:**
|
**Closed issues:**
|
||||||
@@ -182,6 +115,7 @@
|
|||||||
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58)
|
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58)
|
||||||
|
|
||||||
## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03)
|
## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
@@ -189,16 +123,21 @@
|
|||||||
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57)
|
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57)
|
||||||
|
|
||||||
## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27)
|
## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1)
|
||||||
|
|
||||||
## [1.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26)
|
## [1.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.8...1.3.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.8...1.3.0)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/github-changelog-generator/issues/55)
|
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/github-changelog-generator/issues/55)
|
||||||
|
|
||||||
- Separate list exclude and include labels [\#52](https://github.com/skywinder/github-changelog-generator/issues/52)
|
- Separate list exclude and include labels [\#52](https://github.com/skywinder/github-changelog-generator/issues/52)
|
||||||
|
|
||||||
- Unreleased issues in separate section [\#47](https://github.com/skywinder/github-changelog-generator/issues/47)
|
- Unreleased issues in separate section [\#47](https://github.com/skywinder/github-changelog-generator/issues/47)
|
||||||
|
|
||||||
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/github-changelog-generator/issues/31)
|
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/github-changelog-generator/issues/31)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
@@ -210,6 +149,7 @@
|
|||||||
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder))
|
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.2.8](https://github.com/skywinder/github-changelog-generator/tree/1.2.8) (2015-02-17)
|
## [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)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.7...1.2.8)
|
||||||
|
|
||||||
**Closed issues:**
|
**Closed issues:**
|
||||||
@@ -219,16 +159,19 @@
|
|||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder))
|
- Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder))
|
- Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
|
## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
|
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
|
||||||
|
|
||||||
## [1.2.6](https://github.com/skywinder/github-changelog-generator/tree/1.2.6) (2015-01-21)
|
## [1.2.6](https://github.com/skywinder/github-changelog-generator/tree/1.2.6) (2015-01-21)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
@@ -236,6 +179,7 @@
|
|||||||
- fix link tag format [\#45](https://github.com/skywinder/github-changelog-generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
- fix link tag format [\#45](https://github.com/skywinder/github-changelog-generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
||||||
|
|
||||||
## [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:**
|
||||||
@@ -245,26 +189,31 @@
|
|||||||
**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)
|
||||||
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
|
|
||||||
|
|
||||||
**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))
|
||||||
|
|
||||||
- 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))
|
||||||
|
|
||||||
## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
|
## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41)
|
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41)
|
||||||
|
|
||||||
- Crash when try generate log for rails [\#35](https://github.com/skywinder/github-changelog-generator/issues/35)
|
- Crash when try generate log for rails [\#35](https://github.com/skywinder/github-changelog-generator/issues/35)
|
||||||
|
|
||||||
## [1.2.3](https://github.com/skywinder/github-changelog-generator/tree/1.2.3) (2014-12-16)
|
## [1.2.3](https://github.com/skywinder/github-changelog-generator/tree/1.2.3) (2014-12-16)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.2...1.2.3)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.2...1.2.3)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38)
|
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38)
|
||||||
|
|
||||||
- Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33)
|
- Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
@@ -274,9 +223,11 @@
|
|||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder))
|
- Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder))
|
- Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.2.2](https://github.com/skywinder/github-changelog-generator/tree/1.2.2) (2014-12-10)
|
## [1.2.2](https://github.com/skywinder/github-changelog-generator/tree/1.2.2) (2014-12-10)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
@@ -288,6 +239,7 @@
|
|||||||
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
||||||
|
|
||||||
## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
|
## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
@@ -297,18 +249,23 @@
|
|||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Issues for last tag not in list [\#29](https://github.com/skywinder/github-changelog-generator/pull/29) ([skywinder](https://github.com/skywinder))
|
- Issues for last tag not in list [\#29](https://github.com/skywinder/github-changelog-generator/pull/29) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/github-changelog-generator/pull/28) ([skywinder](https://github.com/skywinder))
|
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/github-changelog-generator/pull/28) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19)
|
## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.4...1.2.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.4...1.2.0)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/github-changelog-generator/pull/27) ([skywinder](https://github.com/skywinder))
|
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/github-changelog-generator/pull/27) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/github-changelog-generator/pull/25) ([skywinder](https://github.com/skywinder))
|
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/github-changelog-generator/pull/25) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/github-changelog-generator/pull/24) ([skywinder](https://github.com/skywinder))
|
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/github-changelog-generator/pull/24) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.1.4](https://github.com/skywinder/github-changelog-generator/tree/1.1.4) (2014-11-18)
|
## [1.1.4](https://github.com/skywinder/github-changelog-generator/tree/1.1.4) (2014-11-18)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
@@ -320,23 +277,29 @@
|
|||||||
- Sort tags by date [\#23](https://github.com/skywinder/github-changelog-generator/pull/23) ([skywinder](https://github.com/skywinder))
|
- Sort tags by date [\#23](https://github.com/skywinder/github-changelog-generator/pull/23) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.1.2](https://github.com/skywinder/github-changelog-generator/tree/1.1.2) (2014-11-12)
|
## [1.1.2](https://github.com/skywinder/github-changelog-generator/tree/1.1.2) (2014-11-12)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/github-changelog-generator/pull/18) ([skywinder](https://github.com/skywinder))
|
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/github-changelog-generator/pull/18) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/github-changelog-generator/pull/17) ([skywinder](https://github.com/skywinder))
|
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/github-changelog-generator/pull/17) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.1.1](https://github.com/skywinder/github-changelog-generator/tree/1.1.1) (2014-11-10)
|
## [1.1.1](https://github.com/skywinder/github-changelog-generator/tree/1.1.1) (2014-11-10)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/github-changelog-generator/pull/15) ([skywinder](https://github.com/skywinder))
|
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/github-changelog-generator/pull/15) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Sort issues by tags [\#14](https://github.com/skywinder/github-changelog-generator/pull/14) ([skywinder](https://github.com/skywinder))
|
- Sort issues by tags [\#14](https://github.com/skywinder/github-changelog-generator/pull/14) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/github-changelog-generator/pull/13) ([skywinder](https://github.com/skywinder))
|
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/github-changelog-generator/pull/13) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.1.0](https://github.com/skywinder/github-changelog-generator/tree/1.1.0) (2014-11-10)
|
## [1.1.0](https://github.com/skywinder/github-changelog-generator/tree/1.1.0) (2014-11-10)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.1...1.1.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.1...1.1.0)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
@@ -346,19 +309,22 @@
|
|||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/github-changelog-generator/issues/12)
|
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/github-changelog-generator/issues/12)
|
||||||
|
|
||||||
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/github-changelog-generator/issues/9)
|
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/github-changelog-generator/issues/9)
|
||||||
|
|
||||||
## [1.0.1](https://github.com/skywinder/github-changelog-generator/tree/1.0.1) (2014-11-10)
|
## [1.0.1](https://github.com/skywinder/github-changelog-generator/tree/1.0.1) (2014-11-10)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.0...1.0.1)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.0...1.0.1)
|
||||||
|
|
||||||
## [1.0.0](https://github.com/skywinder/github-changelog-generator/tree/1.0.0) (2014-11-07)
|
## [1.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)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.1.0...1.0.0)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
|
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
|
||||||
|
|
||||||
- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
|
- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
|
||||||
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
@@ -366,21 +332,28 @@
|
|||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
|
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
|
## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.2...0.1.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.2...0.1.0)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Fix parsing date of pull request [\#3](https://github.com/skywinder/github-changelog-generator/pull/3) ([skywinder](https://github.com/skywinder))
|
- Fix parsing date of pull request [\#3](https://github.com/skywinder/github-changelog-generator/pull/3) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add changelog generation for last tag [\#2](https://github.com/skywinder/github-changelog-generator/pull/2) ([skywinder](https://github.com/skywinder))
|
- Add changelog generation for last tag [\#2](https://github.com/skywinder/github-changelog-generator/pull/2) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/github-changelog-generator/pull/1) ([skywinder](https://github.com/skywinder))
|
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/github-changelog-generator/pull/1) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [0.0.2](https://github.com/skywinder/github-changelog-generator/tree/0.0.2) (2014-11-06)
|
## [0.0.2](https://github.com/skywinder/github-changelog-generator/tree/0.0.2) (2014-11-06)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.1...0.0.2)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.1...0.0.2)
|
||||||
|
|
||||||
## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
|
## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||||
15
Gemfile
15
Gemfile
@@ -1,11 +1,14 @@
|
|||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
|
|
||||||
gemspec
|
gem "rake", ">=10.4.2"
|
||||||
|
|
||||||
|
gem "github_api", ">=0.12.3"
|
||||||
|
gem "colorize", ">=0.7.7"
|
||||||
|
|
||||||
group :test do
|
group :test do
|
||||||
gem "rspec", "~>3.2"
|
gem "rspec"
|
||||||
gem "rubocop", "~>0.31"
|
gem "rubocop"
|
||||||
gem "coveralls", "~>0.8", require: false
|
gem "coveralls", require: false
|
||||||
gem "simplecov", "~>0.10", require: false
|
gem "simplecov", require: false
|
||||||
gem "codeclimate-test-reporter", "~>0.4"
|
gem "codeclimate-test-reporter"
|
||||||
end
|
end
|
||||||
|
|||||||
82
Gemfile.lock
82
Gemfile.lock
@@ -1,21 +1,14 @@
|
|||||||
PATH
|
|
||||||
remote: .
|
|
||||||
specs:
|
|
||||||
github_changelog_generator (1.8.1)
|
|
||||||
colorize (~> 0.7)
|
|
||||||
github_api (~> 0.12)
|
|
||||||
|
|
||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
addressable (2.3.8)
|
addressable (2.3.8)
|
||||||
ast (2.0.0)
|
ast (2.0.0)
|
||||||
astrolabe (1.3.1)
|
astrolabe (1.3.0)
|
||||||
parser (~> 2.2)
|
parser (>= 2.2.0.pre.3, < 3.0)
|
||||||
codeclimate-test-reporter (0.4.7)
|
codeclimate-test-reporter (0.4.7)
|
||||||
simplecov (>= 0.7.1, < 1.0.0)
|
simplecov (>= 0.7.1, < 1.0.0)
|
||||||
colorize (0.7.7)
|
colorize (0.7.7)
|
||||||
coveralls (0.8.2)
|
coveralls (0.8.1)
|
||||||
json (~> 1.8)
|
json (~> 1.8)
|
||||||
rest-client (>= 1.6.8, < 2)
|
rest-client (>= 1.6.8, < 2)
|
||||||
simplecov (~> 0.10.0)
|
simplecov (~> 0.10.0)
|
||||||
@@ -29,22 +22,22 @@ GEM
|
|||||||
unf (>= 0.0.5, < 1.0.0)
|
unf (>= 0.0.5, < 1.0.0)
|
||||||
faraday (0.9.1)
|
faraday (0.9.1)
|
||||||
multipart-post (>= 1.2, < 3)
|
multipart-post (>= 1.2, < 3)
|
||||||
github_api (0.12.4)
|
github_api (0.12.3)
|
||||||
addressable (~> 2.3)
|
addressable (~> 2.3)
|
||||||
descendants_tracker (~> 0.0.4)
|
descendants_tracker (~> 0.0.4)
|
||||||
faraday (~> 0.8, < 0.10)
|
faraday (~> 0.8, < 0.10)
|
||||||
hashie (>= 3.4)
|
hashie (>= 3.3)
|
||||||
multi_json (>= 1.7.5, < 2.0)
|
multi_json (>= 1.7.5, < 2.0)
|
||||||
nokogiri (~> 1.6.6)
|
nokogiri (~> 1.6.3)
|
||||||
oauth2
|
oauth2
|
||||||
hashie (3.4.2)
|
hashie (3.4.1)
|
||||||
http-cookie (1.0.2)
|
http-cookie (1.0.2)
|
||||||
domain_name (~> 0.5)
|
domain_name (~> 0.5)
|
||||||
json (1.8.3)
|
json (1.8.2)
|
||||||
jwt (1.5.1)
|
jwt (1.5.0)
|
||||||
mime-types (2.6.1)
|
mime-types (2.5)
|
||||||
mini_portile (0.6.2)
|
mini_portile (0.6.2)
|
||||||
multi_json (1.11.2)
|
multi_json (1.11.0)
|
||||||
multi_xml (0.5.5)
|
multi_xml (0.5.5)
|
||||||
multipart-post (2.0.0)
|
multipart-post (2.0.0)
|
||||||
netrc (0.10.3)
|
netrc (0.10.3)
|
||||||
@@ -56,32 +49,32 @@ GEM
|
|||||||
multi_json (~> 1.3)
|
multi_json (~> 1.3)
|
||||||
multi_xml (~> 0.5)
|
multi_xml (~> 0.5)
|
||||||
rack (~> 1.2)
|
rack (~> 1.2)
|
||||||
parser (2.2.2.6)
|
parser (2.2.2.2)
|
||||||
ast (>= 1.1, < 3.0)
|
ast (>= 1.1, < 3.0)
|
||||||
powerpack (0.1.1)
|
powerpack (0.1.1)
|
||||||
rack (1.6.4)
|
rack (1.6.1)
|
||||||
rainbow (2.0.0)
|
rainbow (2.0.0)
|
||||||
rake (10.4.2)
|
rake (10.4.2)
|
||||||
rest-client (1.8.0)
|
rest-client (1.8.0)
|
||||||
http-cookie (>= 1.0.2, < 2.0)
|
http-cookie (>= 1.0.2, < 2.0)
|
||||||
mime-types (>= 1.16, < 3.0)
|
mime-types (>= 1.16, < 3.0)
|
||||||
netrc (~> 0.7)
|
netrc (~> 0.7)
|
||||||
rspec (3.3.0)
|
rspec (3.2.0)
|
||||||
rspec-core (~> 3.3.0)
|
rspec-core (~> 3.2.0)
|
||||||
rspec-expectations (~> 3.3.0)
|
rspec-expectations (~> 3.2.0)
|
||||||
rspec-mocks (~> 3.3.0)
|
rspec-mocks (~> 3.2.0)
|
||||||
rspec-core (3.3.2)
|
rspec-core (3.2.3)
|
||||||
rspec-support (~> 3.3.0)
|
rspec-support (~> 3.2.0)
|
||||||
rspec-expectations (3.3.1)
|
rspec-expectations (3.2.1)
|
||||||
diff-lcs (>= 1.2.0, < 2.0)
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
rspec-support (~> 3.3.0)
|
rspec-support (~> 3.2.0)
|
||||||
rspec-mocks (3.3.2)
|
rspec-mocks (3.2.1)
|
||||||
diff-lcs (>= 1.2.0, < 2.0)
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
rspec-support (~> 3.3.0)
|
rspec-support (~> 3.2.0)
|
||||||
rspec-support (3.3.0)
|
rspec-support (3.2.2)
|
||||||
rubocop (0.32.1)
|
rubocop (0.31.0)
|
||||||
astrolabe (~> 1.3)
|
astrolabe (~> 1.3)
|
||||||
parser (>= 2.2.2.5, < 3.0)
|
parser (>= 2.2.2.1, < 3.0)
|
||||||
powerpack (~> 0.1)
|
powerpack (~> 0.1)
|
||||||
rainbow (>= 1.99.1, < 3.0)
|
rainbow (>= 1.99.1, < 3.0)
|
||||||
ruby-progressbar (~> 1.4)
|
ruby-progressbar (~> 1.4)
|
||||||
@@ -91,11 +84,11 @@ GEM
|
|||||||
json (~> 1.8)
|
json (~> 1.8)
|
||||||
simplecov-html (~> 0.10.0)
|
simplecov-html (~> 0.10.0)
|
||||||
simplecov-html (0.10.0)
|
simplecov-html (0.10.0)
|
||||||
term-ansicolor (1.3.2)
|
term-ansicolor (1.3.0)
|
||||||
tins (~> 1.0)
|
tins (~> 1.0)
|
||||||
thor (0.19.1)
|
thor (0.19.1)
|
||||||
thread_safe (0.3.5)
|
thread_safe (0.3.5)
|
||||||
tins (1.5.4)
|
tins (1.5.1)
|
||||||
unf (0.1.4)
|
unf (0.1.4)
|
||||||
unf_ext
|
unf_ext
|
||||||
unf_ext (0.0.7.1)
|
unf_ext (0.0.7.1)
|
||||||
@@ -104,14 +97,11 @@ PLATFORMS
|
|||||||
ruby
|
ruby
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
bundler (~> 1.7)
|
codeclimate-test-reporter
|
||||||
codeclimate-test-reporter (~> 0.4)
|
colorize (>= 0.7.7)
|
||||||
coveralls (~> 0.8)
|
coveralls
|
||||||
github_changelog_generator!
|
github_api (>= 0.12.3)
|
||||||
rake (~> 10.0)
|
rake (>= 10.4.2)
|
||||||
rspec (~> 3.2)
|
rspec
|
||||||
rubocop (~> 0.31)
|
rubocop
|
||||||
simplecov (~> 0.10)
|
simplecov
|
||||||
|
|
||||||
BUNDLED WITH
|
|
||||||
1.10.6
|
|
||||||
|
|||||||
434
README.md
434
README.md
@@ -1,218 +1,218 @@
|
|||||||
[](http://badge.fury.io/rb/github_changelog_generator)
|
[](http://badge.fury.io/rb/github_changelog_generator)
|
||||||
[](https://gemnasium.com/skywinder/github-changelog-generator)
|
[](https://gemnasium.com/skywinder/github-changelog-generator)
|
||||||
[](https://travis-ci.org/skywinder/github-changelog-generator)
|
[](https://travis-ci.org/skywinder/github-changelog-generator)
|
||||||
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
|
|
||||||
GitHub Changelog Generator 
|
GitHub Changelog Generator 
|
||||||
==================
|
==================
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Output example](#output-example)
|
- [Output example](#output-example)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Params](#params)
|
- [Params](#params)
|
||||||
- [GitHub token](#github-token)
|
- [GitHub token](#github-token)
|
||||||
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
||||||
- [Alternatives](#alternatives)
|
- [Alternatives](#alternatives)
|
||||||
- [Projects using this library](#projects-using-this-library)
|
- [Projects using this library](#projects-using-this-library)
|
||||||
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
|
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
|
||||||
- [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.
|
||||||
|
|
||||||
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:
|
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?*
|
>### *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.
|
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?*
|
### *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.
|
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.
|
||||||
|
|
||||||
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
[sudo] gem install github_changelog_generator
|
[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
|
- 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:
|
- [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
|
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
||||||
|
|
||||||
- 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:
|
||||||
|
|
||||||
github_changelog_generator
|
github_changelog_generator
|
||||||
|
|
||||||
- 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
|
||||||
Type `github_changelog_generator --help` for details.
|
Type `github_changelog_generator --help` for detailed usage.
|
||||||
|
|
||||||
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)
|
Usage: changelog_generator [options]
|
||||||
|
-u, --user [USER] Username of the owner of target GitHub repo
|
||||||
### GitHub token
|
-p, --project [PROJECT] Name of project on GitHub
|
||||||
|
-t, --token [TOKEN] To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new
|
||||||
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
|
||||||
|
-o, --output [NAME] Output file. Default is CHANGELOG.md
|
||||||
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
|
--[no-]verbose Run verbosely. Default is true
|
||||||
|
--[no-]issues Include closed issues to changelog. Default is true
|
||||||
And:
|
--[no-]issues-wo-labels Include closed issues without labels to changelog. Default is true
|
||||||
|
--[no-]pr-wo-labels Include pull requests without labels to changelog. Default is true
|
||||||
- Run with key `-t [your-40-digit-token]`
|
--[no-]pull-requests Include pull-requests to changelog. Default is true
|
||||||
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
--[no-]filter-by-milestone Use milestone to detect when issue was resolved. Default is true
|
||||||
|
--[no-]author Add author of pull-request in the end. Default is true
|
||||||
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
--unreleased-only Generate log from unreleased closed issues only.
|
||||||
|
--[no-]unreleased Add to log unreleased closed issues. Default is true
|
||||||
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
--[no-]compare-link Include compare link between older version and newer version. Default is true
|
||||||
|
--include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
|
||||||
So, if you got error like this:
|
--exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
||||||
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
--max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited.
|
||||||
|
--github-site [URL] The Enterprise Github site on which your project is hosted.
|
||||||
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
--github-api [URL] The enterprise endpoint to use for your Github API.
|
||||||
|
--future-release [RELEASE-VERSION] Put the unreleased changes in the specified release number.
|
||||||
## Migrating from a manual changelog
|
-v, --version Print version number
|
||||||
|
-h, --help Displays Help
|
||||||
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.
|
|
||||||
|
### GitHub token
|
||||||
That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
|
|
||||||
|
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
||||||
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
|
|
||||||
|
**You can easily [generate it here](https://github.com/settings/tokens)**.
|
||||||
### Rake task
|
|
||||||
|
And:
|
||||||
You love Rake? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
|
|
||||||
|
- Run with key `-t [your-16-digit-token]`
|
||||||
```ruby
|
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
||||||
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
|
||||||
config.since_tag = '0.1.14'
|
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
||||||
config.future_release = '0.2.0'
|
|
||||||
end
|
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
||||||
```
|
|
||||||
|
So, if you got error like this:
|
||||||
All command line options can be passed to the Rake task as `config` parameters. Since you're naming the Rake task yourself, you can create as many as you want, too.
|
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
||||||
|
|
||||||
##Features and advantages of this project
|
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||||
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
|
|
||||||
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
##Features and advantages of this project
|
||||||
- **GitHub Enterprise support** via command line options! :factory:
|
- Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
|
||||||
- Flexible format **customisation**:
|
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
||||||
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
|
- **GitHub Enterprise support** via command line options! :factory:
|
||||||
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
|
- Flexible format **customisation**:
|
||||||
- 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:
|
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
|
||||||
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
|
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
|
||||||
- **Distinguish** issues **according labels**. :mag_right:
|
- 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:
|
||||||
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
|
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
|
||||||
- Bug fixes (by label `bug` in issue) :beetle:
|
- **Distinguish** issues **according labels**. :mag_right:
|
||||||
- Enhancements (by label `enhancement` in issue) :star2:
|
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
|
||||||
- Issues (closed issues `w/o any labels`) :non-potable_water:
|
- Bug fixes (by label `bug` in issue) :beetle:
|
||||||
|
- Enhancements (by label `enhancement` in issue) :star2:
|
||||||
- You can manually set which labels should be included/excluded. :wrench:
|
- Issues (closed issues `w/o any labels`) :non-potable_water:
|
||||||
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
|
|
||||||
(*look `github_changelog_generator --help` for details)*
|
- 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 none satisfied my requirements.
|
|
||||||
|
###Alternatives
|
||||||
*If you know other projects - feel free to edit this Wiki page!*
|
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!*
|
||||||
### Projects using this library
|
|
||||||
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
|
||||||
|
### Projects using this library
|
||||||
|
[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.
|
||||||
|
|
||||||
*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.*
|
*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 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:
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
- ***I already use GitHub Releases. Why do I need this?***
|
- ***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:
|
||||||
|
|
||||||
*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
||||||
|
|
||||||
I'm not try to compare quality of auto-generated and manually generated logs.. but:
|
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!
|
The auto generated Changelog really helps even if you manually fill Releases notes!
|
||||||
|
|
||||||
For example:
|
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`.
|
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.
|
- 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.
|
- this file can also help you to build your Release note and not miss features in manually-filled list.
|
||||||
|
|
||||||
In the end:
|
In the end:
|
||||||
|
|
||||||
I think, that GitHub Releases is more for end-users.
|
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.
|
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.
|
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
|
||||||
|
|
||||||
- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
|
- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
|
||||||
|
|
||||||
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
|
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
|
||||||
|
|
||||||
If you're seeing this warning:
|
If you're seeing this warning:
|
||||||
|
|
||||||
1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
|
1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
|
||||||
2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
1. Create an issue to discuss about your idea
|
1. Create an issue to discuss about your idea
|
||||||
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
||||||
3. Create your feature branch (`git checkout -b my-new-feature`)
|
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||||
5. Push to the branch (`git push origin my-new-feature`)
|
5. Push to the branch (`git push origin my-new-feature`)
|
||||||
6. Create a new Pull Request
|
6. Create a new Pull Request
|
||||||
7. Profit! :white_check_mark:
|
7. Profit! :white_check_mark:
|
||||||
|
|
||||||
*To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
|
## License
|
||||||
|
|
||||||
## License
|
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||||
|
|
||||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
|
||||||
|
|||||||
@@ -23,10 +23,9 @@ Gem::Specification.new do |spec|
|
|||||||
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||||
spec.require_paths = ["lib"]
|
spec.require_paths = ["lib"]
|
||||||
|
|
||||||
spec.add_runtime_dependency("github_api", ["~> 0.12"])
|
|
||||||
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
|
||||||
|
|
||||||
# Development only
|
|
||||||
spec.add_development_dependency "bundler", "~> 1.7"
|
spec.add_development_dependency "bundler", "~> 1.7"
|
||||||
spec.add_development_dependency "rake", "~> 10.0"
|
spec.add_development_dependency "rake", "~> 10.0"
|
||||||
|
|
||||||
|
spec.add_runtime_dependency("github_api", ["~> 0.12"])
|
||||||
|
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,32 +1,7 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/changelog_test/compare/0.0.4...HEAD)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
|
|
||||||
- PR with enhancement label [\#16](https://github.com/skywinder/changelog_test/pull/16) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- BugFix [\#11](https://github.com/skywinder/changelog_test/issues/11)
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- Issue closed from commit from PR [\#14](https://github.com/skywinder/changelog_test/issues/14)
|
|
||||||
- Issue, closed by PR [\#12](https://github.com/skywinder/changelog_test/issues/12)
|
|
||||||
- Issue [\#10](https://github.com/skywinder/changelog_test/issues/10)
|
|
||||||
- Issue with some other label - Should be in closed issues [\#8](https://github.com/skywinder/changelog_test/issues/8)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- 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 to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
|
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)
|
||||||
|
|
||||||
**Closed issues:**
|
**Closed issues:**
|
||||||
@@ -38,6 +13,7 @@
|
|||||||
- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
|
- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
|
## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
@@ -45,6 +21,7 @@
|
|||||||
- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
|
- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
|
## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
@@ -54,4 +31,5 @@
|
|||||||
## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
|
## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||||
@@ -5,7 +5,6 @@ require "json"
|
|||||||
require "colorize"
|
require "colorize"
|
||||||
require "benchmark"
|
require "benchmark"
|
||||||
|
|
||||||
require_relative "github_changelog_generator/helper"
|
|
||||||
require_relative "github_changelog_generator/parser"
|
require_relative "github_changelog_generator/parser"
|
||||||
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"
|
||||||
|
|||||||
@@ -1,10 +1,11 @@
|
|||||||
|
require "logger"
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
|
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
|
||||||
# (such as filtering, validating, e.t.c)
|
# (such as filtering, validating, e.t.c)
|
||||||
#
|
#
|
||||||
# Example:
|
# Example:
|
||||||
# fetcher = GitHubChangelogGenerator::Fetcher.new options
|
# fetcher = GitHubChangelogGenerator::Fetcher.new options
|
||||||
|
|
||||||
class Fetcher
|
class Fetcher
|
||||||
PER_PAGE_NUMBER = 30
|
PER_PAGE_NUMBER = 30
|
||||||
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
|
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
|
||||||
@@ -15,9 +16,16 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
def initialize(options = {})
|
def initialize(options = {})
|
||||||
@options = options || {}
|
@options = options || {}
|
||||||
|
|
||||||
|
@logger = Logger.new(STDOUT)
|
||||||
|
@logger.formatter = proc do |_severity, _datetime, _progname, msg|
|
||||||
|
"#{msg}\n"
|
||||||
|
end
|
||||||
|
|
||||||
@user = @options[:user]
|
@user = @options[:user]
|
||||||
@project = @options[:project]
|
@project = @options[:project]
|
||||||
@github_token = fetch_github_token
|
@github_token = fetch_github_token
|
||||||
|
@tag_times_hash = {}
|
||||||
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?
|
||||||
@@ -33,7 +41,7 @@ module GitHubChangelogGenerator
|
|||||||
def fetch_github_token
|
def fetch_github_token
|
||||||
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
|
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
|
||||||
|
|
||||||
Helper.log.warn NO_TOKEN_PROVIDED.yellow unless env_var
|
@logger.warn NO_TOKEN_PROVIDED.yellow unless env_var
|
||||||
|
|
||||||
env_var
|
env_var
|
||||||
end
|
end
|
||||||
@@ -43,28 +51,27 @@ module GitHubChangelogGenerator
|
|||||||
def get_all_tags
|
def get_all_tags
|
||||||
print "Fetching tags...\r" if @options[:verbose]
|
print "Fetching tags...\r" if @options[:verbose]
|
||||||
|
|
||||||
check_github_response { github_fetch_tags }
|
tags = []
|
||||||
|
|
||||||
|
check_github_response { github_fetch_tags(tags) }
|
||||||
|
|
||||||
|
tags
|
||||||
end
|
end
|
||||||
|
|
||||||
# This is wrapper with rescue block
|
|
||||||
# @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
|
|
||||||
def check_github_response
|
def check_github_response
|
||||||
begin
|
begin
|
||||||
value = yield
|
value = yield
|
||||||
rescue Github::Error::Unauthorized => e
|
rescue Github::Error::Unauthorized => e
|
||||||
Helper.log.error e.body.red
|
@logger.error e.body.red
|
||||||
abort "Error: wrong GitHub token"
|
abort "Error: wrong GitHub token"
|
||||||
rescue Github::Error::Forbidden => e
|
rescue Github::Error::Forbidden => e
|
||||||
Helper.log.warn e.body.red
|
@logger.warn e.body.red
|
||||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
value
|
value
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fill input array with tags
|
def github_fetch_tags(tags)
|
||||||
# @return [Array] array of tags in repo
|
|
||||||
def github_fetch_tags
|
|
||||||
tags = []
|
|
||||||
response = @github.repos.tags @options[:user], @options[:project]
|
response = @github.repos.tags @options[:user], @options[:project]
|
||||||
page_i = 0
|
page_i = 0
|
||||||
count_pages = response.count_pages
|
count_pages = response.count_pages
|
||||||
@@ -76,12 +83,11 @@ module GitHubChangelogGenerator
|
|||||||
print_empty_line
|
print_empty_line
|
||||||
|
|
||||||
if tags.count == 0
|
if tags.count == 0
|
||||||
Helper.log.warn "Warning: Can't find any tags in repo.\
|
@logger.warn "Warning: Can't find any tags in repo.\
|
||||||
Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||||
else
|
else
|
||||||
Helper.log.info "Found #{tags.count} tags"
|
@logger.info "Found #{tags.count} tags"
|
||||||
end
|
end
|
||||||
tags
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# This method fetch all closed issues and separate them to pull requests and pure issues
|
# This method fetch all closed issues and separate them to pull requests and pure issues
|
||||||
@@ -106,10 +112,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
||||||
end
|
end
|
||||||
print_empty_line
|
print_empty_line
|
||||||
Helper.log.info "Received issues: #{issues.count}"
|
@logger.info "Received issues: #{issues.count}"
|
||||||
|
|
||||||
rescue
|
rescue
|
||||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
|
|
||||||
# separate arrays of issues and pull requests:
|
# separate arrays of issues and pull requests:
|
||||||
@@ -134,20 +140,17 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
end
|
end
|
||||||
print_empty_line
|
print_empty_line
|
||||||
rescue
|
rescue
|
||||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
|
|
||||||
Helper.log.info "Fetching merged dates: #{pull_requests.count}"
|
@logger.info "Fetching merged dates: #{pull_requests.count}"
|
||||||
pull_requests
|
pull_requests
|
||||||
end
|
end
|
||||||
|
|
||||||
# Print specified line on the same string
|
|
||||||
# @param [String] log_string
|
|
||||||
def print_in_same_line(log_string)
|
def print_in_same_line(log_string)
|
||||||
print log_string + "\r"
|
print log_string + "\r"
|
||||||
end
|
end
|
||||||
|
|
||||||
# Print long line with spaces on same line to clear prev message
|
|
||||||
def print_empty_line
|
def print_empty_line
|
||||||
print_in_same_line(" ")
|
print_in_same_line(" ")
|
||||||
end
|
end
|
||||||
@@ -163,16 +166,13 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
issues_slice.each do |issue|
|
issues_slice.each do |issue|
|
||||||
threads << Thread.new do
|
threads << Thread.new do
|
||||||
begin
|
begin
|
||||||
response = @github.issues.events.list user: @options[:user],
|
obj = @github.issues.events.list user: @options[:user],
|
||||||
repo: @options[:project],
|
repo: @options[:project],
|
||||||
issue_number: issue["number"]
|
issue_number: issue["number"]
|
||||||
issue[:events] = []
|
|
||||||
response.each_page do |page|
|
|
||||||
issue[:events].concat(page)
|
|
||||||
end
|
|
||||||
rescue
|
rescue
|
||||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
|
issue[:events] = obj.body
|
||||||
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
|
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
|
||||||
i += 1
|
i += 1
|
||||||
end
|
end
|
||||||
@@ -184,26 +184,32 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
# to clear line from prev print
|
# to clear line from prev print
|
||||||
print_empty_line
|
print_empty_line
|
||||||
|
|
||||||
Helper.log.info "Fetching events for issues and PR: #{i}"
|
@logger.info "Fetching events for issues and PR: #{i}"
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fetch tag time from repo
|
# Try to find tag date in local hash.
|
||||||
#
|
# Otherwise fFetch tag time and put it to local hash file.
|
||||||
# @param [Hash] tag
|
# @param [String] tag_name name of the tag
|
||||||
# @return [Time] time of specified tag
|
# @return [Time] time of specified tag
|
||||||
def fetch_date_of_tag(tag)
|
def get_time_of_tag(tag_name)
|
||||||
begin
|
fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
|
||||||
commit_data = @github.git_data.commits.get @options[:user],
|
|
||||||
@options[:project],
|
if @tag_times_hash[tag_name["name"]]
|
||||||
tag["commit"]["sha"]
|
return @tag_times_hash[tag_name["name"]]
|
||||||
rescue
|
|
||||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
|
||||||
end
|
end
|
||||||
time_string = commit_data["committer"]["date"]
|
|
||||||
Time.parse(time_string)
|
begin
|
||||||
|
github_git_data_commits_get = @github.git_data.commits.get @options[:user],
|
||||||
|
@options[:project],
|
||||||
|
tag_name["commit"]["sha"]
|
||||||
|
rescue
|
||||||
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
time_string = github_git_data_commits_get["committer"]["date"]
|
||||||
|
@tag_times_hash[tag_name["name"]] = Time.parse(time_string)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fetch commit for specified event
|
# Fetch commit for specifed event
|
||||||
# @return [Hash]
|
# @return [Hash]
|
||||||
def fetch_commit(event)
|
def fetch_commit(event)
|
||||||
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
require_relative "../fetcher"
|
require "github_changelog_generator/fetcher"
|
||||||
require_relative "generator_generation"
|
require_relative "generator_generation"
|
||||||
require_relative "generator_fetcher"
|
require_relative "generator_fetcher"
|
||||||
require_relative "generator_processor"
|
require_relative "generator_processor"
|
||||||
@@ -10,7 +10,7 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
class Generator
|
class Generator
|
||||||
attr_accessor :options, :filtered_tags, :github
|
attr_accessor :options, :all_tags, :github
|
||||||
|
|
||||||
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues
|
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues
|
||||||
#
|
#
|
||||||
@@ -19,7 +19,7 @@ module GitHubChangelogGenerator
|
|||||||
# content = generator.compound_changelog
|
# content = generator.compound_changelog
|
||||||
def initialize(options = nil)
|
def initialize(options = nil)
|
||||||
@options = options || {}
|
@options = options || {}
|
||||||
@tag_times_hash = {}
|
|
||||||
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
|
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ module GitHubChangelogGenerator
|
|||||||
def encapsulate_string(string)
|
def encapsulate_string(string)
|
||||||
string.gsub! '\\', '\\\\'
|
string.gsub! '\\', '\\\\'
|
||||||
|
|
||||||
encpas_chars = %w(< > * _ \( \) [ ] #)
|
encpas_chars = %w(> * _ \( \) [ ] #)
|
||||||
encpas_chars.each do |char|
|
encpas_chars.each do |char|
|
||||||
string.gsub! char, "\\#{char}"
|
string.gsub! char, "\\#{char}"
|
||||||
end
|
end
|
||||||
@@ -56,7 +56,7 @@ module GitHubChangelogGenerator
|
|||||||
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
||||||
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
|
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
|
||||||
# @return [String] Ready and parsed section
|
# @return [String] Ready and parsed section
|
||||||
def create_log_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
|
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
|
||||||
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
|
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
|
||||||
|
|
||||||
github_site = options[:github_site] || "https://github.com"
|
github_site = options[:github_site] || "https://github.com"
|
||||||
@@ -66,7 +66,7 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
if @options[:issues]
|
if @options[:issues]
|
||||||
# Generate issues:
|
# Generate issues:
|
||||||
log += issues_to_log(issues, pull_requests)
|
log += issues_to_log(issues)
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:pulls]
|
if @options[:pulls]
|
||||||
@@ -77,14 +77,13 @@ module GitHubChangelogGenerator
|
|||||||
log
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
# Generate ready-to-paste log from list of issues and pull requests.
|
# Generate ready-to-paste log from list of issues.
|
||||||
#
|
#
|
||||||
# @param [Array] issues
|
# @param [Array] issues
|
||||||
# @param [Array] pull_requests
|
|
||||||
# @return [String] generated log for issues
|
# @return [String] generated log for issues
|
||||||
def issues_to_log(issues, pull_requests)
|
def issues_to_log(issues)
|
||||||
log = ""
|
log = ""
|
||||||
bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
|
bugs_a, enhancement_a, issues_a = parse_by_sections(issues)
|
||||||
|
|
||||||
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
||||||
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
||||||
@@ -96,9 +95,8 @@ module GitHubChangelogGenerator
|
|||||||
# (bugs, features, or just closed issues) by labels
|
# (bugs, features, or just closed issues) by labels
|
||||||
#
|
#
|
||||||
# @param [Array] issues
|
# @param [Array] issues
|
||||||
# @param [Array] pull_requests
|
|
||||||
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
|
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
|
||||||
def parse_by_sections(issues, pull_requests)
|
def parse_by_sections(issues)
|
||||||
issues_a = []
|
issues_a = []
|
||||||
enhancement_a = []
|
enhancement_a = []
|
||||||
bugs_a = []
|
bugs_a = []
|
||||||
@@ -106,12 +104,12 @@ module GitHubChangelogGenerator
|
|||||||
issues.each do |dict|
|
issues.each do |dict|
|
||||||
added = false
|
added = false
|
||||||
dict.labels.each do |label|
|
dict.labels.each do |label|
|
||||||
if @options[:bug_labels].include? label.name
|
if label.name == "bug"
|
||||||
bugs_a.push dict
|
bugs_a.push dict
|
||||||
added = true
|
added = true
|
||||||
next
|
next
|
||||||
end
|
end
|
||||||
if @options[:enhancement_labels].include? label.name
|
if label.name == "enhancement"
|
||||||
enhancement_a.push dict
|
enhancement_a.push dict
|
||||||
added = true
|
added = true
|
||||||
next
|
next
|
||||||
@@ -119,24 +117,6 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
issues_a.push dict unless added
|
issues_a.push dict unless added
|
||||||
end
|
end
|
||||||
|
|
||||||
added_pull_requests = []
|
|
||||||
pull_requests.each do |dict|
|
|
||||||
dict.labels.each do |label|
|
|
||||||
if @options[:bug_labels].include? label.name
|
|
||||||
bugs_a.push dict
|
|
||||||
added_pull_requests.push dict
|
|
||||||
next
|
|
||||||
end
|
|
||||||
if @options[:enhancement_labels].include? label.name
|
|
||||||
enhancement_a.push dict
|
|
||||||
added_pull_requests.push dict
|
|
||||||
next
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
added_pull_requests.each { |p| pull_requests.delete(p) }
|
|
||||||
|
|
||||||
[bugs_a, enhancement_a, issues_a]
|
[bugs_a, enhancement_a, issues_a]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -17,11 +17,11 @@ module GitHubChangelogGenerator
|
|||||||
# Async fetching tags:
|
# Async fetching tags:
|
||||||
threads = []
|
threads = []
|
||||||
i = 0
|
i = 0
|
||||||
all = @filtered_tags.count
|
all = @all_tags.count
|
||||||
@filtered_tags.each do |tag|
|
@all_tags.each do |tag|
|
||||||
print " \r"
|
print " \r"
|
||||||
threads << Thread.new do
|
threads << Thread.new do
|
||||||
get_time_of_tag(tag)
|
@fetcher.get_time_of_tag(tag)
|
||||||
print "Fetching tags dates: #{i + 1}/#{all}\r" if @options[:verbose]
|
print "Fetching tags dates: #{i + 1}/#{all}\r" if @options[:verbose]
|
||||||
i += 1
|
i += 1
|
||||||
end
|
end
|
||||||
@@ -41,18 +41,18 @@ module GitHubChangelogGenerator
|
|||||||
threads << Thread.new { find_closed_date_by_commit(issue) }
|
threads << Thread.new { find_closed_date_by_commit(issue) }
|
||||||
end
|
end
|
||||||
threads.each(&:join)
|
threads.each(&:join)
|
||||||
|
puts "Fetching closed dates for issues: Done!" if @options[:verbose]
|
||||||
end
|
end
|
||||||
puts "Fetching closed dates for issues: Done!" if @options[:verbose]
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
|
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
|
||||||
# @param [Hash] issue
|
# @param [Hash] issue
|
||||||
def find_closed_date_by_commit(issue)
|
def find_closed_date_by_commit(issue)
|
||||||
unless issue[:events].nil?
|
unless issue["events"].nil?
|
||||||
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
||||||
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
|
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
|
||||||
# reverse! - to find latest closed event. (event goes in date order)
|
# reverse! - to find latest closed event. (event goes in date order)
|
||||||
issue[:events].reverse!.each do |event|
|
issue["events"].reverse!.each do |event|
|
||||||
if event[:event].eql? compare_string
|
if event[:event].eql? compare_string
|
||||||
set_date_from_event(event, issue)
|
set_date_from_event(event, issue)
|
||||||
break
|
break
|
||||||
|
|||||||
@@ -5,19 +5,16 @@ module GitHubChangelogGenerator
|
|||||||
# @return [String] Generated change log file
|
# @return [String] Generated change log file
|
||||||
def compound_changelog
|
def compound_changelog
|
||||||
fetch_and_filter_tags
|
fetch_and_filter_tags
|
||||||
sort_tags_by_date(@filtered_tags)
|
|
||||||
fetch_issues_and_pr
|
fetch_issues_and_pr
|
||||||
|
|
||||||
log = "#{@options[:header]}\n\n"
|
log = "# Change Log\n\n"
|
||||||
|
|
||||||
if @options[:unreleased_only]
|
if @options[:unreleased_only]
|
||||||
log += generate_log_between_tags(filtered_tags[0], nil)
|
log += generate_log_between_tags(all_tags[0], nil)
|
||||||
else
|
else
|
||||||
log += generate_log_for_all_tags
|
log += generate_log_for_all_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
log += File.read(@options[:base]) if File.file?(@options[:base])
|
|
||||||
|
|
||||||
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||||
@log = log
|
@log = log
|
||||||
end
|
end
|
||||||
@@ -27,7 +24,7 @@ module GitHubChangelogGenerator
|
|||||||
tag1 = @options[:tag1]
|
tag1 = @options[:tag1]
|
||||||
tag2 = @options[:tag2]
|
tag2 = @options[:tag2]
|
||||||
tags_strings = []
|
tags_strings = []
|
||||||
filtered_tags.each { |x| tags_strings.push(x["name"]) }
|
all_tags.each { |x| tags_strings.push(x["name"]) }
|
||||||
|
|
||||||
if tags_strings.include?(tag1)
|
if tags_strings.include?(tag1)
|
||||||
if tags_strings.include?(tag2)
|
if tags_strings.include?(tag2)
|
||||||
@@ -51,13 +48,13 @@ module GitHubChangelogGenerator
|
|||||||
def generate_sub_section(issues, prefix)
|
def generate_sub_section(issues, prefix)
|
||||||
log = ""
|
log = ""
|
||||||
|
|
||||||
|
log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
|
||||||
|
|
||||||
if issues.any?
|
if issues.any?
|
||||||
log += "#{prefix}\n\n" unless options[:simple_list]
|
|
||||||
issues.each do |issue|
|
issues.each do |issue|
|
||||||
merge_string = get_string_for_issue(issue)
|
merge_string = get_string_for_issue(issue)
|
||||||
log += "- #{merge_string}\n"
|
log += "- #{merge_string}\n\n"
|
||||||
end
|
end
|
||||||
log += "\n"
|
|
||||||
end
|
end
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
@@ -77,15 +74,10 @@ module GitHubChangelogGenerator
|
|||||||
time_string = newer_tag_time.strftime @options[:date_format]
|
time_string = newer_tag_time.strftime @options[:date_format]
|
||||||
|
|
||||||
# Generate tag name and link
|
# Generate tag name and link
|
||||||
if @options[:release_url]
|
|
||||||
release_url = format(@options[:release_url], newer_tag_link)
|
|
||||||
else
|
|
||||||
release_url = "#{project_url}/tree/#{newer_tag_link}"
|
|
||||||
end
|
|
||||||
if newer_tag_name.equal? @options[:unreleased_label]
|
if newer_tag_name.equal? @options[:unreleased_label]
|
||||||
log += "## [#{newer_tag_name}](#{release_url})\n\n"
|
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
|
||||||
else
|
else
|
||||||
log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
|
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:compare_link] && older_tag_link
|
if @options[:compare_link] && older_tag_link
|
||||||
@@ -102,14 +94,14 @@ module GitHubChangelogGenerator
|
|||||||
def generate_log_between_tags(older_tag, newer_tag)
|
def generate_log_between_tags(older_tag, newer_tag)
|
||||||
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
|
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
|
||||||
|
|
||||||
older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
|
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
|
||||||
|
|
||||||
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
|
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
|
||||||
# do not generate empty unreleased section
|
# do not generate empty unreleased section
|
||||||
return ""
|
return ""
|
||||||
end
|
end
|
||||||
|
|
||||||
create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Apply all filters to issues and pull requests
|
# Apply all filters to issues and pull requests
|
||||||
@@ -136,11 +128,11 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
log = generate_unreleased_section
|
log = generate_unreleased_section
|
||||||
|
|
||||||
(1...filtered_tags.size).each do |index|
|
(1...all_tags.size).each do |index|
|
||||||
log += generate_log_between_tags(filtered_tags[index], filtered_tags[index - 1])
|
log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
|
||||||
end
|
end
|
||||||
if @filtered_tags.count != 0
|
if @all_tags.count != 0
|
||||||
log += generate_log_between_tags(nil, filtered_tags.last)
|
log += generate_log_between_tags(nil, all_tags.last)
|
||||||
end
|
end
|
||||||
|
|
||||||
log
|
log
|
||||||
@@ -149,7 +141,7 @@ module GitHubChangelogGenerator
|
|||||||
def generate_unreleased_section
|
def generate_unreleased_section
|
||||||
log = ""
|
log = ""
|
||||||
if @options[:unreleased]
|
if @options[:unreleased]
|
||||||
unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
|
unreleased_log = generate_log_between_tags(all_tags[0], nil)
|
||||||
log += unreleased_log if unreleased_log
|
log += unreleased_log if unreleased_log
|
||||||
end
|
end
|
||||||
log
|
log
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ module GitHubChangelogGenerator
|
|||||||
false
|
false
|
||||||
else
|
else
|
||||||
# check, that this milestone in tag list:
|
# check, that this milestone in tag list:
|
||||||
milestone_is_tag = @filtered_tags.find do |tag|
|
milestone_is_tag = @all_tags.find do |tag|
|
||||||
tag.name == issue.milestone.title
|
tag.name == issue.milestone.title
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -57,27 +57,27 @@ module GitHubChangelogGenerator
|
|||||||
true
|
true
|
||||||
else
|
else
|
||||||
# check, that this milestone in tag list:
|
# check, that this milestone in tag list:
|
||||||
@filtered_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Method filter issues, that belong only specified tag range
|
# Method filter issues, that belong only specified tag range
|
||||||
# @param [Array] issues issues to filter
|
# @param [Array] array of issues to filter
|
||||||
# @param [Symbol] hash_key key of date value default is :actual_date
|
# @param [Symbol] hash_key key of date value default is :actual_date
|
||||||
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
||||||
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
||||||
# @return [Array] filtered issues
|
# @return [Array] filtered issues
|
||||||
def delete_by_time(issues, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
|
def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
|
||||||
# in case if not tags specified - return unchanged array
|
# in case if not tags specified - return unchanged array
|
||||||
return issues if older_tag.nil? && newer_tag.nil?
|
return array if older_tag.nil? && newer_tag.nil?
|
||||||
|
|
||||||
newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
|
newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
|
||||||
older_tag_time = older_tag && get_time_of_tag(older_tag)
|
older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
|
||||||
|
|
||||||
issues.select do |issue|
|
array.select do |req|
|
||||||
if issue[hash_key]
|
if req[hash_key]
|
||||||
time = Time.parse(issue[hash_key]).utc
|
time = Time.parse(req[hash_key]).utc
|
||||||
|
|
||||||
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
||||||
|
|
||||||
|
|||||||
@@ -2,34 +2,15 @@ module GitHubChangelogGenerator
|
|||||||
class Generator
|
class Generator
|
||||||
# fetch, filter tags, fetch dates and sort them in time order
|
# fetch, filter tags, fetch dates and sort them in time order
|
||||||
def fetch_and_filter_tags
|
def fetch_and_filter_tags
|
||||||
@filtered_tags = get_filtered_tags(@fetcher.get_all_tags)
|
@all_tags = get_filtered_tags(@fetcher.get_all_tags)
|
||||||
fetch_tags_dates
|
fetch_tags_dates
|
||||||
|
sort_tags_by_date
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sort all tags by date
|
# Sort all tags by date
|
||||||
def sort_tags_by_date(tags)
|
def sort_tags_by_date
|
||||||
puts "Sorting tags..." if @options[:verbose]
|
puts "Sorting tags..." if @options[:verbose]
|
||||||
tags.sort_by! do |x|
|
@all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
|
||||||
get_time_of_tag(x)
|
|
||||||
end.reverse!
|
|
||||||
end
|
|
||||||
|
|
||||||
# Try to find tag date in local hash.
|
|
||||||
# Otherwise fFetch tag time and put it to local hash file.
|
|
||||||
# @param [Hash] tag_name name of the tag
|
|
||||||
# @return [Time] time of specified tag
|
|
||||||
def get_time_of_tag(tag_name)
|
|
||||||
fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
|
|
||||||
|
|
||||||
name_of_tag = tag_name["name"]
|
|
||||||
time_for_name = @tag_times_hash[name_of_tag]
|
|
||||||
if !time_for_name.nil?
|
|
||||||
time_for_name
|
|
||||||
else
|
|
||||||
time_string = @fetcher.fetch_date_of_tag tag_name
|
|
||||||
@tag_times_hash[name_of_tag] = time_string
|
|
||||||
time_string
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Detect link, name and time for specified tag.
|
# Detect link, name and time for specified tag.
|
||||||
@@ -38,7 +19,7 @@ module GitHubChangelogGenerator
|
|||||||
# @return [Array] link, name and time of the tag
|
# @return [Array] link, name and time of the tag
|
||||||
def detect_link_tag_time(newer_tag)
|
def detect_link_tag_time(newer_tag)
|
||||||
# if tag is nil - set current time
|
# if tag is nil - set current time
|
||||||
newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
|
newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
|
||||||
|
|
||||||
# if it's future release tag - set this value
|
# if it's future release tag - set this value
|
||||||
if newer_tag.nil? && @options[:future_release]
|
if newer_tag.nil? && @options[:future_release]
|
||||||
@@ -52,93 +33,19 @@ module GitHubChangelogGenerator
|
|||||||
[newer_tag_link, newer_tag_name, newer_tag_time]
|
[newer_tag_link, newer_tag_name, newer_tag_time]
|
||||||
end
|
end
|
||||||
|
|
||||||
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
|
|
||||||
def detect_since_tag
|
|
||||||
@since_tag ||= @options[:since_tag]
|
|
||||||
if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
|
|
||||||
reader = GitHubChangelogGenerator::Reader.new
|
|
||||||
content = reader.read(@options[:base])
|
|
||||||
@since_tag = content[0]["version"] if content
|
|
||||||
end
|
|
||||||
@since_tag
|
|
||||||
end
|
|
||||||
|
|
||||||
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
||||||
#
|
#
|
||||||
# @return [Array]
|
# @return [Array]
|
||||||
def get_filtered_tags(all_tags)
|
def get_filtered_tags(all_tags)
|
||||||
filtered_tags = filter_since_tag(all_tags)
|
all_tags = all_tags
|
||||||
filtered_tags = filter_between_tags(filtered_tags)
|
|
||||||
filter_excluded_tags(filtered_tags)
|
|
||||||
end
|
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
|
||||||
# @return [Array] filtered tags according :since_tag option
|
|
||||||
def filter_since_tag(all_tags)
|
|
||||||
filtered_tags = all_tags
|
|
||||||
tag = detect_since_tag
|
|
||||||
if tag
|
|
||||||
if all_tags.map(&:name).include? tag
|
|
||||||
idx = all_tags.index { |t| t.name == tag }
|
|
||||||
if idx > 0
|
|
||||||
filtered_tags = all_tags[0..idx - 1]
|
|
||||||
else
|
|
||||||
filtered_tags = []
|
|
||||||
end
|
|
||||||
else
|
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
|
|
||||||
end
|
|
||||||
end
|
|
||||||
filtered_tags
|
|
||||||
end
|
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
|
||||||
# @return [Array] filtered tags according :due_tag option
|
|
||||||
def filter_due_tag(all_tags)
|
|
||||||
filtered_tags = all_tags
|
|
||||||
tag = @options[:due_tag]
|
|
||||||
if tag
|
|
||||||
if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
|
|
||||||
idx = all_tags.index { |t| t.name == tag }
|
|
||||||
last_index = all_tags.count - 1
|
|
||||||
if idx > 0 && idx < last_index
|
|
||||||
filtered_tags = all_tags[idx + 1..last_index]
|
|
||||||
else
|
|
||||||
filtered_tags = []
|
|
||||||
end
|
|
||||||
else
|
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
|
|
||||||
end
|
|
||||||
end
|
|
||||||
filtered_tags
|
|
||||||
end
|
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
|
||||||
# @return [Array] filtered tags according :between_tags option
|
|
||||||
def filter_between_tags(all_tags)
|
|
||||||
filtered_tags = all_tags
|
filtered_tags = all_tags
|
||||||
if @options[:between_tags]
|
if @options[:between_tags]
|
||||||
@options[:between_tags].each do |tag|
|
@options[:between_tags].each do |tag|
|
||||||
unless all_tags.map(&:name).include? tag
|
unless all_tags.include? tag
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
|
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag.name }
|
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
|
||||||
end
|
|
||||||
filtered_tags
|
|
||||||
end
|
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
|
||||||
# @return [Array] filtered tags according :exclude_tags option
|
|
||||||
def filter_excluded_tags(all_tags)
|
|
||||||
filtered_tags = all_tags
|
|
||||||
if @options[:exclude_tags]
|
|
||||||
@options[:exclude_tags].each do |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 = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
|
|
||||||
end
|
end
|
||||||
filtered_tags
|
filtered_tags
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,37 +0,0 @@
|
|||||||
require "logger"
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
module Helper
|
|
||||||
# @return true if the currently running program is a unit test
|
|
||||||
def self.test?
|
|
||||||
defined?SpecHelper
|
|
||||||
end
|
|
||||||
|
|
||||||
if test?
|
|
||||||
@log ||= Logger.new(nil) # don't show any logs when running tests
|
|
||||||
else
|
|
||||||
@log ||= Logger.new(STDOUT)
|
|
||||||
end
|
|
||||||
@log.formatter = proc do |severity, _datetime, _progname, msg|
|
|
||||||
string = "#{msg}\n"
|
|
||||||
|
|
||||||
if severity == "DEBUG"
|
|
||||||
string = string.magenta
|
|
||||||
elsif severity == "INFO"
|
|
||||||
string = string.white
|
|
||||||
elsif severity == "WARN"
|
|
||||||
string = string.yellow
|
|
||||||
elsif severity == "ERROR"
|
|
||||||
string = string.red
|
|
||||||
elsif severity == "FATAL"
|
|
||||||
string = string.red.bold
|
|
||||||
end
|
|
||||||
|
|
||||||
string
|
|
||||||
end
|
|
||||||
|
|
||||||
# Logging happens using this method
|
|
||||||
class << self
|
|
||||||
attr_reader :log
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
require "optparse"
|
require "optparse"
|
||||||
require "pp"
|
require "pp"
|
||||||
require_relative "version"
|
require_relative "version"
|
||||||
require_relative "helper"
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Parser
|
class Parser
|
||||||
# parse options with optparse
|
# parse options with optparse
|
||||||
@@ -13,9 +13,7 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
parser.parse!
|
parser.parse!
|
||||||
|
|
||||||
if options[:user].nil? || options[:project].nil?
|
detect_user_and_project(options)
|
||||||
detect_user_and_project(options, ARGV[0], ARGV[1])
|
|
||||||
end
|
|
||||||
|
|
||||||
if !options[:user] || !options[:project]
|
if !options[:user] || !options[:project]
|
||||||
puts parser.banner
|
puts parser.banner
|
||||||
@@ -23,10 +21,8 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
if options[:verbose]
|
if options[:verbose]
|
||||||
Helper.log.info "Performing task with options:"
|
puts "Performing task with options:"
|
||||||
options_to_display = options
|
pp options
|
||||||
options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
|
|
||||||
pp options_to_display
|
|
||||||
puts ""
|
puts ""
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -52,24 +48,6 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
||||||
options[:output] = last
|
options[:output] = last
|
||||||
end
|
end
|
||||||
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
|
|
||||||
options[:base] = last
|
|
||||||
end
|
|
||||||
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
|
|
||||||
options[:bug_prefix] = v
|
|
||||||
end
|
|
||||||
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
|
|
||||||
options[:enhancement_prefix] = v
|
|
||||||
end
|
|
||||||
opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
|
|
||||||
options[:issue_prefix] = v
|
|
||||||
end
|
|
||||||
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
|
|
||||||
options[:header] = v
|
|
||||||
end
|
|
||||||
opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
|
|
||||||
options[:merge_prefix] = v
|
|
||||||
end
|
|
||||||
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
|
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
|
||||||
options[:issues] = v
|
options[:issues] = v
|
||||||
end
|
end
|
||||||
@@ -100,36 +78,18 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
|
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
|
||||||
options[:compare_link] = v
|
options[:compare_link] = v
|
||||||
end
|
end
|
||||||
opts.on("--include-labels x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
|
opts.on("--include-labels x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
|
||||||
options[:include_labels] = list
|
options[:include_labels] = list
|
||||||
end
|
end
|
||||||
opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
|
opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
|
||||||
options[:exclude_labels] = list
|
options[:exclude_labels] = list
|
||||||
end
|
end
|
||||||
opts.on("--bug-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
|
opts.on("--between-tags x,y,z", Array, "Change log will be filed only between specified tags") do |list|
|
||||||
options[:bug_labels] = list
|
|
||||||
end
|
|
||||||
opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
|
|
||||||
options[:enhancement_labels] = list
|
|
||||||
end
|
|
||||||
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
|
|
||||||
options[:between_tags] = list
|
options[:between_tags] = list
|
||||||
end
|
end
|
||||||
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
|
|
||||||
options[:exclude_tags] = list
|
|
||||||
end
|
|
||||||
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
|
|
||||||
options[:since_tag] = v
|
|
||||||
end
|
|
||||||
opts.on("--due-tag x", "Change log will end before specified tag") do |v|
|
|
||||||
options[:due_tag] = v
|
|
||||||
end
|
|
||||||
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
||||||
options[:max_issues] = max
|
options[:max_issues] = max
|
||||||
end
|
end
|
||||||
opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
|
|
||||||
options[:release_url] = url
|
|
||||||
end
|
|
||||||
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
|
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
|
||||||
options[:github_site] = last
|
options[:github_site] = last
|
||||||
end
|
end
|
||||||
@@ -164,7 +124,6 @@ module GitHubChangelogGenerator
|
|||||||
tag2: nil,
|
tag2: nil,
|
||||||
date_format: "%Y-%m-%d",
|
date_format: "%Y-%m-%d",
|
||||||
output: "CHANGELOG.md",
|
output: "CHANGELOG.md",
|
||||||
base: "HISTORY.md",
|
|
||||||
issues: true,
|
issues: true,
|
||||||
add_issues_wo_labels: true,
|
add_issues_wo_labels: true,
|
||||||
add_pr_wo_labels: true,
|
add_pr_wo_labels: true,
|
||||||
@@ -174,13 +133,11 @@ module GitHubChangelogGenerator
|
|||||||
unreleased: true,
|
unreleased: true,
|
||||||
unreleased_label: "Unreleased",
|
unreleased_label: "Unreleased",
|
||||||
compare_link: true,
|
compare_link: true,
|
||||||
enhancement_labels: %w(enhancement Enhancement),
|
include_labels: %w(bug enhancement),
|
||||||
bug_labels: %w(bug Bug),
|
exclude_labels: %w(duplicate question invalid wontfix),
|
||||||
exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
|
|
||||||
max_issues: nil,
|
max_issues: nil,
|
||||||
simple_list: false,
|
simple_list: false,
|
||||||
verbose: true,
|
verbose: true,
|
||||||
header: "# Change Log",
|
|
||||||
merge_prefix: "**Merged pull requests:**",
|
merge_prefix: "**Merged pull requests:**",
|
||||||
issue_prefix: "**Closed issues:**",
|
issue_prefix: "**Closed issues:**",
|
||||||
bug_prefix: "**Fixed bugs:**",
|
bug_prefix: "**Fixed bugs:**",
|
||||||
@@ -192,8 +149,8 @@ module GitHubChangelogGenerator
|
|||||||
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)
|
||||||
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
|
options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site])
|
||||||
if !options[:user] || !options[:project]
|
if !options[:user] || !options[:project]
|
||||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||||
options[:user] = "skywinder"
|
options[:user] = "skywinder"
|
||||||
|
|||||||
@@ -1,68 +0,0 @@
|
|||||||
require "rake"
|
|
||||||
require "rake/tasklib"
|
|
||||||
require "github_changelog_generator"
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
class RakeTask < ::Rake::TaskLib
|
|
||||||
include ::Rake::DSL if defined?(::Rake::DSL)
|
|
||||||
|
|
||||||
OPTIONS = %w( user project token date_format output
|
|
||||||
bug_prefix enhancement_prefix issue_prefix
|
|
||||||
header merge_prefix issues
|
|
||||||
add_issues_wo_labels add_pr_wo_labels
|
|
||||||
pulls filter_issues_by_milestone author
|
|
||||||
unreleased_only unreleased unreleased_label
|
|
||||||
compare_link include_labels exclude_labels
|
|
||||||
bug_labels enhancement_labels
|
|
||||||
between_tags exclude_tags since_tag max_issues
|
|
||||||
github_site github_endpoint simple_list
|
|
||||||
future_release verbose release_url )
|
|
||||||
|
|
||||||
OPTIONS.each do |o|
|
|
||||||
attr_accessor o.to_sym
|
|
||||||
end
|
|
||||||
|
|
||||||
# Public: Initialise a new GitHubChangelogGenerator::RakeTask.
|
|
||||||
#
|
|
||||||
# Example
|
|
||||||
#
|
|
||||||
# GitHubChangelogGenerator::RakeTask.new
|
|
||||||
def initialize(*args, &task_block)
|
|
||||||
@name = args.shift || :changelog
|
|
||||||
|
|
||||||
define(args, &task_block)
|
|
||||||
end
|
|
||||||
|
|
||||||
def define(args, &task_block)
|
|
||||||
desc "Generate a Change log from GitHub"
|
|
||||||
|
|
||||||
task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
|
|
||||||
|
|
||||||
# clear any (auto-)pre-existing task
|
|
||||||
Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
|
|
||||||
|
|
||||||
task @name do
|
|
||||||
# mimick parse_options
|
|
||||||
options = Parser.get_default_options
|
|
||||||
|
|
||||||
if options[:user].nil? || options[:project].nil?
|
|
||||||
Parser.detect_user_and_project(options)
|
|
||||||
end
|
|
||||||
|
|
||||||
OPTIONS.each do |o|
|
|
||||||
v = instance_variable_get("@#{o}")
|
|
||||||
options[o.to_sym] = v if v
|
|
||||||
end
|
|
||||||
|
|
||||||
generator = Generator.new options
|
|
||||||
|
|
||||||
log = generator.compound_changelog
|
|
||||||
|
|
||||||
output_filename = "#{options[:output]}"
|
|
||||||
File.open(output_filename, "w") { |file| file.write(log) }
|
|
||||||
puts "Done!"
|
|
||||||
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,3 +1,3 @@
|
|||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
VERSION = "1.8.3"
|
VERSION = "1.4.1"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -19,10 +19,6 @@ require "codeclimate-test-reporter"
|
|||||||
require "simplecov"
|
require "simplecov"
|
||||||
require "coveralls"
|
require "coveralls"
|
||||||
|
|
||||||
# This module is only used to check the environment is currently a testing env
|
|
||||||
module SpecHelper
|
|
||||||
end
|
|
||||||
|
|
||||||
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
||||||
Coveralls::SimpleCov::Formatter,
|
Coveralls::SimpleCov::Formatter,
|
||||||
SimpleCov::Formatter::HTMLFormatter,
|
SimpleCov::Formatter::HTMLFormatter,
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ describe GitHubChangelogGenerator::Fetcher do
|
|||||||
@fetcher = GitHubChangelogGenerator::Fetcher.new(options)
|
@fetcher = GitHubChangelogGenerator::Fetcher.new(options)
|
||||||
end
|
end
|
||||||
it "should raise Unauthorized error" do
|
it "should raise Unauthorized error" do
|
||||||
expect { @fetcher.github_fetch_tags }.to raise_error Github::Error::Unauthorized
|
expect { @fetcher.github_fetch_tags [] }.to raise_error Github::Error::Unauthorized
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,219 +1,29 @@
|
|||||||
def tag_mash_with_name(tag)
|
|
||||||
mash_tag = Hashie::Mash.new
|
|
||||||
mash_tag.name = tag
|
|
||||||
mash_tag
|
|
||||||
end
|
|
||||||
|
|
||||||
def tags_mash_from_strings(tags_strings)
|
|
||||||
mash_array = []
|
|
||||||
tags_strings.each do |tag|
|
|
||||||
mash_tag = tag_mash_with_name(tag)
|
|
||||||
mash_array << mash_tag
|
|
||||||
end
|
|
||||||
mash_array
|
|
||||||
end
|
|
||||||
|
|
||||||
describe GitHubChangelogGenerator::Generator do
|
describe GitHubChangelogGenerator::Generator do
|
||||||
describe "#filter_between_tags" do
|
|
||||||
context "when between_tags nil" do
|
|
||||||
before do
|
|
||||||
@generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
|
|
||||||
end
|
|
||||||
|
|
||||||
subject do
|
|
||||||
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
|
||||||
end
|
|
||||||
it { is_expected.to be_a(Array) }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
end
|
|
||||||
context "when between_tags same as input array" do
|
|
||||||
before do
|
|
||||||
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
|
|
||||||
end
|
|
||||||
subject do
|
|
||||||
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
|
||||||
end
|
|
||||||
it { is_expected.to be_a(Array) }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when between_tags filled with correct values" do
|
|
||||||
before do
|
|
||||||
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
|
|
||||||
end
|
|
||||||
subject do
|
|
||||||
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
|
||||||
end
|
|
||||||
it { is_expected.to be_a(Array) }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when between_tags filled with invalid values" do
|
|
||||||
before do
|
|
||||||
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
|
|
||||||
end
|
|
||||||
|
|
||||||
subject do
|
|
||||||
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
|
||||||
end
|
|
||||||
it { is_expected.to be_a(Array) }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#get_filtered_tags" do
|
describe "#get_filtered_tags" do
|
||||||
subject do
|
|
||||||
generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3 4 5)))
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with excluded and between tags" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 3))) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#filter_excluded_tags" do
|
|
||||||
subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
|
|
||||||
context "with valid excluded tags" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid excluded tags" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#filter_since_tag" do
|
|
||||||
context "with filled array" do
|
|
||||||
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
|
|
||||||
context "with valid since tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid since tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with empty array" do
|
|
||||||
subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
|
|
||||||
|
|
||||||
context "with valid since tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid since tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#filter_due_tag" do
|
|
||||||
context "with filled array" do
|
|
||||||
subject { generator.filter_due_tag(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
|
|
||||||
context "with valid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(3))) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with empty array" do
|
|
||||||
subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
|
|
||||||
|
|
||||||
context "with valid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#get_time_of_tag" do
|
|
||||||
current_time = Time.now
|
|
||||||
before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
|
|
||||||
context "run with nil parameter" do
|
|
||||||
it "should raise ChangelogGeneratorError" do
|
|
||||||
expect { @generator.get_time_of_tag nil }.to raise_error(GitHubChangelogGenerator::ChangelogGeneratorError)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
context "fetch already filled tag" do
|
|
||||||
before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
|
|
||||||
subject { @generator.get_time_of_tag tag_mash_with_name("valid_tag") }
|
|
||||||
it { is_expected.to be_a_kind_of(Time) }
|
|
||||||
it { is_expected.to eq(current_time) }
|
|
||||||
end
|
|
||||||
context "fetch not filled tag" do
|
|
||||||
before do
|
|
||||||
mock = double("fake fetcher")
|
|
||||||
allow(mock).to receive_messages(fetch_date_of_tag: current_time)
|
|
||||||
@generator.instance_variable_set :@fetcher, mock
|
|
||||||
end
|
|
||||||
subject do
|
|
||||||
of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
|
|
||||||
of_tag
|
|
||||||
end
|
|
||||||
it { is_expected.to be_a_kind_of(Time) }
|
|
||||||
it { is_expected.to eq(current_time) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#sort_tags_by_date" do
|
|
||||||
time1 = Time.now
|
|
||||||
time2 = Time.now
|
|
||||||
time3 = Time.now
|
|
||||||
before(:all) do
|
before(:all) do
|
||||||
@generator = GitHubChangelogGenerator::Generator.new
|
@generator = GitHubChangelogGenerator::Generator.new
|
||||||
end
|
end
|
||||||
context "sort unsorted tags" do
|
|
||||||
tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
|
context "when between_tags nil" do
|
||||||
before do
|
# before(:each) do
|
||||||
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
# @generator.options = {}
|
||||||
end
|
# end
|
||||||
subject do
|
subject { @generator.get_filtered_tags(%w(1 2 3)) }
|
||||||
@generator.sort_tags_by_date tags
|
it { is_expected.to be_a(Array) }
|
||||||
end
|
it { is_expected.to match_array(%w(1 2 3)) }
|
||||||
it { is_expected.to be_a_kind_of(Array) }
|
|
||||||
it { is_expected.to match_array(tags.reverse!) }
|
|
||||||
end
|
end
|
||||||
context "sort sorted tags" do
|
|
||||||
tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
|
context "when between_tags 1" do
|
||||||
before do
|
# before(:each) do
|
||||||
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
# @generator.options = {between_tags: ["1"]}
|
||||||
end
|
# end
|
||||||
|
|
||||||
subject do
|
subject do
|
||||||
@generator.sort_tags_by_date tags
|
@generator.instance_variable_set("@options", between_tags: ["1"])
|
||||||
|
@generator.get_filtered_tags(%w(1 2 3))
|
||||||
end
|
end
|
||||||
it { is_expected.to be_a_kind_of(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(tags) }
|
it { is_expected.to match_array(%w(1)) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,21 +1,21 @@
|
|||||||
describe GitHubChangelogGenerator::Parser do
|
describe GitHubChangelogGenerator::Parser do
|
||||||
describe ".user_project_from_remote" do
|
describe "#self.user_project_from_remote" do
|
||||||
context "when remote is type 1" do
|
context "when remote is 1" do
|
||||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
end
|
end
|
||||||
context "when remote is type 2" do
|
context "when remote is 2" do
|
||||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
end
|
end
|
||||||
context "when remote is type 3" do
|
context "when remote is 3" do
|
||||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
end
|
end
|
||||||
context "when remote is type 4" do
|
context "when remote is 4" do
|
||||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
@@ -26,10 +26,10 @@ describe GitHubChangelogGenerator::Parser do
|
|||||||
it { is_expected.to match_array([nil, nil]) }
|
it { is_expected.to match_array([nil, nil]) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
describe ".user_project_from_option" do
|
describe "#self.user_project_from_option" do
|
||||||
context "when option is invalid" do
|
# context "when option is invalid" do
|
||||||
it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
|
# it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
|
||||||
end
|
# end
|
||||||
|
|
||||||
context "when option is valid" do
|
context "when option is valid" do
|
||||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
|
||||||
|
|||||||
Reference in New Issue
Block a user