Compare commits
4 Commits
1.13.1
...
dlanileona
| Author | SHA1 | Date | |
|---|---|---|---|
|
930372b572 | ||
|
|
6a1b4f553f | ||
|
|
23f4a79462 | ||
|
|
8acfcd934f |
9
.gitignore
vendored
9
.gitignore
vendored
@@ -1,9 +0,0 @@
|
||||
bin/
|
||||
!bin/git-generate-changelog
|
||||
!bin/github_changelog_generator
|
||||
pkg/
|
||||
coverage/
|
||||
.bundle
|
||||
spec/*.lock
|
||||
doc
|
||||
.yardoc
|
||||
|
||||
36
.rubocop.yml
36
.rubocop.yml
@@ -18,39 +18,3 @@ Metrics/MethodLength:
|
||||
Style/FileName:
|
||||
Exclude:
|
||||
- 'bin/git-generate-changelog'
|
||||
|
||||
#TODOS
|
||||
# Offense count: 14
|
||||
Metrics/AbcSize:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 1
|
||||
Style/AccessorMethodName:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 10
|
||||
Style/Documentation:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 1
|
||||
# Configuration parameters: MinBodyLength.
|
||||
Style/GuardClause:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 2
|
||||
# Cop supports --auto-correct.
|
||||
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
||||
# SupportedStyles: skip_modifier_ifs, always
|
||||
Style/Next:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 3
|
||||
# Cop supports --auto-correct.
|
||||
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
|
||||
# SupportedStyles: slashes, percent_r, mixed
|
||||
Style/RegexpLiteral:
|
||||
Enabled: false
|
||||
|
||||
Style/MutableConstant:
|
||||
Enabled: false
|
||||
|
||||
|
||||
@@ -1,17 +1,11 @@
|
||||
# This configuration was generated by
|
||||
# `rubocop --auto-gen-config`
|
||||
# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
|
||||
# This configuration was generated by `rubocop --auto-gen-config`
|
||||
# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
|
||||
# The point is for the user to remove these configuration records
|
||||
# one by one as the offenses are removed from the code base.
|
||||
# Note that changes in the inspected code, or installation of new
|
||||
# versions of RuboCop, may require this file to be generated again.
|
||||
|
||||
# Offense count: 1
|
||||
Lint/ImplicitStringConcatenation:
|
||||
Exclude:
|
||||
- 'lib/github_changelog_generator/parser.rb'
|
||||
|
||||
# Offense count: 14
|
||||
# Offense count: 13
|
||||
Metrics/AbcSize:
|
||||
Enabled: false
|
||||
|
||||
@@ -19,11 +13,11 @@ Metrics/AbcSize:
|
||||
Metrics/CyclomaticComplexity:
|
||||
Max: 7
|
||||
|
||||
# Offense count: 2
|
||||
# Offense count: 1
|
||||
Metrics/PerceivedComplexity:
|
||||
Max: 8
|
||||
|
||||
# Offense count: 1
|
||||
# Offense count: 2
|
||||
Style/AccessorMethodName:
|
||||
Enabled: false
|
||||
|
||||
@@ -36,16 +30,13 @@ Style/Documentation:
|
||||
Style/GuardClause:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 2
|
||||
# Cop supports --auto-correct.
|
||||
# Offense count: 1
|
||||
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
||||
# SupportedStyles: skip_modifier_ifs, always
|
||||
Style/Next:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 3
|
||||
# Cop supports --auto-correct.
|
||||
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
|
||||
# SupportedStyles: slashes, percent_r, mixed
|
||||
Style/RegexpLiteral:
|
||||
Enabled: false
|
||||
|
||||
24
.travis.yml
24
.travis.yml
@@ -1,27 +1,13 @@
|
||||
cache:
|
||||
- bundler
|
||||
language: ruby
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem install bundler
|
||||
before_install: gem update --system
|
||||
rvm:
|
||||
- 2.1
|
||||
script: bundle exec rake checks
|
||||
matrix:
|
||||
include:
|
||||
# Test install on clean system
|
||||
- install: true
|
||||
script:
|
||||
- gem build github_changelog_generator
|
||||
- gem install *.gem
|
||||
- install: true
|
||||
script:
|
||||
- gem build github_changelog_generator
|
||||
- bundle install --gemfile spec/install-gem-in-bundler.gemfile
|
||||
- 2.1.0
|
||||
script:
|
||||
- bundle exec rake
|
||||
notifications:
|
||||
email:
|
||||
recipients:
|
||||
- sky4winder+githubchangeloggenerator@gmail.com
|
||||
- sky4winder+githubchangeloggenerator@gmail.com
|
||||
on_success: never
|
||||
on_failure: change
|
||||
addons:
|
||||
|
||||
207
CHANGELOG.md
207
CHANGELOG.md
@@ -1,208 +1,5 @@
|
||||
# Change Log
|
||||
|
||||
## [1.13.0](https://github.com/skywinder/github-changelog-generator/tree/1.13.0) (2016-07-04)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.12.1...1.13.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Carry PR \#301: usernames\_as\_github\_logins [\#392](https://github.com/skywinder/github-changelog-generator/pull/392) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.12.1](https://github.com/skywinder/github-changelog-generator/tree/1.12.1) (2016-05-09)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.12.0...1.12.1)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- github\_changelog\_generator/generator/generator\_tags.rb:61:in `detect\_since\_tag': undefined method `\[\]' for nil:NilClass \(NoMethodError\) [\#351](https://github.com/skywinder/github-changelog-generator/issues/351)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- Add a LICENSE file [\#369](https://github.com/skywinder/github-changelog-generator/issues/369)
|
||||
- Error installing on Ubuntu 14.04 [\#364](https://github.com/skywinder/github-changelog-generator/issues/364)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Move dev gems to add\_development\_dependency [\#373](https://github.com/skywinder/github-changelog-generator/pull/373) ([skywinder](https://github.com/skywinder))
|
||||
- Add MIT LICENSE file [\#370](https://github.com/skywinder/github-changelog-generator/pull/370) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Avoid nil bug in detect\_since\_tag [\#368](https://github.com/skywinder/github-changelog-generator/pull/368) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.12.0](https://github.com/skywinder/github-changelog-generator/tree/1.12.0) (2016-04-01)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.8...1.12.0)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- .github\_changelog\_generator config file is not consistent with the internal options hash [\#312](https://github.com/skywinder/github-changelog-generator/issues/312)
|
||||
- Feature request: YAML front matter [\#276](https://github.com/skywinder/github-changelog-generator/issues/276)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Added tag exclusion with a filter \(string or regex\) [\#320](https://github.com/skywinder/github-changelog-generator/pull/320) ([soundstep](https://github.com/soundstep))
|
||||
|
||||
## [1.11.8](https://github.com/skywinder/github-changelog-generator/tree/1.11.8) (2016-03-22)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.7...1.11.8)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- ParserFile: Allow comments in settings file [\#358](https://github.com/skywinder/github-changelog-generator/pull/358) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Error when specifying exclude\_labels [\#327](https://github.com/skywinder/github-changelog-generator/issues/327)
|
||||
- Parse options file options into arrays, integers, flags, and other [\#354](https://github.com/skywinder/github-changelog-generator/pull/354) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- Installation fails on Ubuntu [\#352](https://github.com/skywinder/github-changelog-generator/issues/352)
|
||||
- Test installing on Windows: use AppVeyor [\#348](https://github.com/skywinder/github-changelog-generator/issues/348)
|
||||
- Can't run under RubyGems 2.5.1 and Ruby 2.3.0 [\#325](https://github.com/skywinder/github-changelog-generator/issues/325)
|
||||
- Ruby 2.3.0 - Deprecation warning: Github::ResponseWrapper\#respond\_to?\(:to\_ary\) is old fashion which takes only one parameter [\#323](https://github.com/skywinder/github-changelog-generator/issues/323)
|
||||
- between-tags and exclude-tags do not work in .github\_changelog\_generator [\#317](https://github.com/skywinder/github-changelog-generator/issues/317)
|
||||
- Add a "documentation" label [\#284](https://github.com/skywinder/github-changelog-generator/issues/284)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Replace shelling-out-to-Git w/ Dir call [\#360](https://github.com/skywinder/github-changelog-generator/pull/360) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- ParserFile: fail parsing with config file line number; use a File instead of a filename [\#357](https://github.com/skywinder/github-changelog-generator/pull/357) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- On gem install, do not try to copy manpage files in the "extensions" step [\#356](https://github.com/skywinder/github-changelog-generator/pull/356) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Refactor: call it option\_name, instead of key\_sym [\#355](https://github.com/skywinder/github-changelog-generator/pull/355) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Add a `bundle install` test [\#353](https://github.com/skywinder/github-changelog-generator/pull/353) ([jkeiser](https://github.com/jkeiser))
|
||||
- Add an AppVeyor config [\#350](https://github.com/skywinder/github-changelog-generator/pull/350) ([Arcanemagus](https://github.com/Arcanemagus))
|
||||
- README: Document GitHub token URI scope [\#345](https://github.com/skywinder/github-changelog-generator/pull/345) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.11.7](https://github.com/skywinder/github-changelog-generator/tree/1.11.7) (2016-03-04)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.6...1.11.7)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add Olle Jonsson as co-author [\#347](https://github.com/skywinder/github-changelog-generator/pull/347) ([skywinder](https://github.com/skywinder))
|
||||
- Gemspec, default date [\#346](https://github.com/skywinder/github-changelog-generator/pull/346) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.11.6](https://github.com/skywinder/github-changelog-generator/tree/1.11.6) (2016-03-01)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.5...1.11.6)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Can't build on Windows [\#340](https://github.com/skywinder/github-changelog-generator/issues/340)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- install error "Not a git repository" [\#339](https://github.com/skywinder/github-changelog-generator/issues/339)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Gemspec: Calculate date using Date stdlib [\#343](https://github.com/skywinder/github-changelog-generator/pull/343) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.11.5](https://github.com/skywinder/github-changelog-generator/tree/1.11.5) (2016-03-01)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.4...1.11.5)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Test clean install in Travis [\#344](https://github.com/skywinder/github-changelog-generator/pull/344) ([jkeiser](https://github.com/jkeiser))
|
||||
- Update Rakefile to avoid install-breaking bug [\#341](https://github.com/skywinder/github-changelog-generator/pull/341) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.11.4](https://github.com/skywinder/github-changelog-generator/tree/1.11.4) (2016-02-26)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.3...1.11.4)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Man page copying: only copy .1 [\#338](https://github.com/skywinder/github-changelog-generator/pull/338) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.11.3](https://github.com/skywinder/github-changelog-generator/tree/1.11.3) (2016-02-25)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.2...1.11.3)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- Cannot install gem [\#335](https://github.com/skywinder/github-changelog-generator/issues/335)
|
||||
|
||||
## [1.11.2](https://github.com/skywinder/github-changelog-generator/tree/1.11.2) (2016-02-25)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.1...1.11.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix installation by not running the specs - which have dependencies [\#337](https://github.com/skywinder/github-changelog-generator/pull/337) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.11.1](https://github.com/skywinder/github-changelog-generator/tree/1.11.1) (2016-02-25)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.0...1.11.1)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add rubocop and rspec as runtime dependencies [\#336](https://github.com/skywinder/github-changelog-generator/pull/336) ([jkeiser](https://github.com/jkeiser))
|
||||
- \[Refactor\] ParserFile class use Pathname [\#334](https://github.com/skywinder/github-changelog-generator/pull/334) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- \[Refactor\] Generator\#exclude\_issues\_by\_labels simpler, tested [\#332](https://github.com/skywinder/github-changelog-generator/pull/332) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.11.0](https://github.com/skywinder/github-changelog-generator/tree/1.11.0) (2016-02-24)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.5...1.11.0)
|
||||
|
||||
## [1.10.5](https://github.com/skywinder/github-changelog-generator/tree/1.10.5) (2016-02-24)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.4...1.10.5)
|
||||
|
||||
## [1.10.4](https://github.com/skywinder/github-changelog-generator/tree/1.10.4) (2016-02-24)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.3...1.10.4)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Rake and Bundler as runtime deps [\#333](https://github.com/skywinder/github-changelog-generator/pull/333) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Test case for \#327 [\#331](https://github.com/skywinder/github-changelog-generator/pull/331) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Fix crash installing on systems without overcommit [\#330](https://github.com/skywinder/github-changelog-generator/pull/330) ([jkeiser](https://github.com/jkeiser))
|
||||
|
||||
## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
|
||||
|
||||
## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
|
||||
|
||||
## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
|
||||
- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
|
||||
|
||||
## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
||||
- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
||||
- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
||||
- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
|
||||
|
||||
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
|
||||
|
||||
@@ -516,6 +313,10 @@
|
||||
|
||||
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/github-changelog-generator/issues/34)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- 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)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
|
||||
|
||||
|
||||
8
Gemfile
8
Gemfile
@@ -3,13 +3,9 @@ source "https://rubygems.org"
|
||||
gemspec
|
||||
|
||||
group :test do
|
||||
gem "rake"
|
||||
gem "bundler"
|
||||
gem "rubocop"
|
||||
gem "overcommit"
|
||||
gem "rspec", "~>3.2"
|
||||
gem "rubocop", "~>0.31"
|
||||
gem "coveralls", "~>0.8", require: false
|
||||
gem "simplecov", "~>0.10", require: false
|
||||
gem "codeclimate-test-reporter", "~>0.4"
|
||||
# JSON 2.0.1 is ruby 2.0+
|
||||
gem "json", "< 2.0"
|
||||
end
|
||||
|
||||
123
Gemfile.lock
123
Gemfile.lock
@@ -1,108 +1,117 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
github_changelog_generator (1.13.0)
|
||||
colorize (>= 0.7)
|
||||
github_api (>= 0.12)
|
||||
rake (>= 10.0)
|
||||
github_changelog_generator (1.9.0)
|
||||
colorize (~> 0.7)
|
||||
github_api (~> 0.12)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.4.0)
|
||||
ast (2.3.0)
|
||||
childprocess (0.5.9)
|
||||
ffi (~> 1.0, >= 1.0.11)
|
||||
codeclimate-test-reporter (0.6.0)
|
||||
addressable (2.3.8)
|
||||
ast (2.0.0)
|
||||
astrolabe (1.3.1)
|
||||
parser (~> 2.2)
|
||||
codeclimate-test-reporter (0.4.7)
|
||||
simplecov (>= 0.7.1, < 1.0.0)
|
||||
colorize (0.8.1)
|
||||
coveralls (0.8.14)
|
||||
json (>= 1.8, < 3)
|
||||
simplecov (~> 0.12.0)
|
||||
colorize (0.7.7)
|
||||
coveralls (0.8.2)
|
||||
json (~> 1.8)
|
||||
rest-client (>= 1.6.8, < 2)
|
||||
simplecov (~> 0.10.0)
|
||||
term-ansicolor (~> 1.3)
|
||||
thor (~> 0.19.1)
|
||||
tins (~> 1.6.0)
|
||||
descendants_tracker (0.0.4)
|
||||
thread_safe (~> 0.3, >= 0.3.1)
|
||||
diff-lcs (1.2.5)
|
||||
docile (1.1.5)
|
||||
faraday (0.9.2)
|
||||
domain_name (0.5.24)
|
||||
unf (>= 0.0.5, < 1.0.0)
|
||||
faraday (0.9.1)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
ffi (1.9.14)
|
||||
github_api (0.14.4)
|
||||
addressable (~> 2.4.0)
|
||||
github_api (0.12.4)
|
||||
addressable (~> 2.3)
|
||||
descendants_tracker (~> 0.0.4)
|
||||
faraday (~> 0.8, < 0.10)
|
||||
hashie (>= 3.4)
|
||||
oauth2 (~> 1.0.0)
|
||||
hashie (3.4.4)
|
||||
iniparse (1.4.2)
|
||||
multi_json (>= 1.7.5, < 2.0)
|
||||
nokogiri (~> 1.6.6)
|
||||
oauth2
|
||||
hashie (3.4.2)
|
||||
http-cookie (1.0.2)
|
||||
domain_name (~> 0.5)
|
||||
json (1.8.3)
|
||||
jwt (1.5.4)
|
||||
multi_json (1.12.1)
|
||||
jwt (1.5.1)
|
||||
mime-types (2.6.1)
|
||||
mini_portile (0.6.2)
|
||||
multi_json (1.11.2)
|
||||
multi_xml (0.5.5)
|
||||
multipart-post (2.0.0)
|
||||
netrc (0.10.3)
|
||||
nokogiri (1.6.6.2)
|
||||
mini_portile (~> 0.6.0)
|
||||
oauth2 (1.0.0)
|
||||
faraday (>= 0.8, < 0.10)
|
||||
jwt (~> 1.0)
|
||||
multi_json (~> 1.3)
|
||||
multi_xml (~> 0.5)
|
||||
rack (~> 1.2)
|
||||
overcommit (0.34.2)
|
||||
childprocess (~> 0.5.8)
|
||||
iniparse (~> 1.4)
|
||||
parser (2.3.1.2)
|
||||
ast (~> 2.2)
|
||||
parser (2.2.2.6)
|
||||
ast (>= 1.1, < 3.0)
|
||||
powerpack (0.1.1)
|
||||
rack (1.6.4)
|
||||
rainbow (2.1.0)
|
||||
rake (11.2.2)
|
||||
rspec (3.5.0)
|
||||
rspec-core (~> 3.5.0)
|
||||
rspec-expectations (~> 3.5.0)
|
||||
rspec-mocks (~> 3.5.0)
|
||||
rspec-core (3.5.1)
|
||||
rspec-support (~> 3.5.0)
|
||||
rspec-expectations (3.5.0)
|
||||
rainbow (2.0.0)
|
||||
rake (10.4.2)
|
||||
rest-client (1.8.0)
|
||||
http-cookie (>= 1.0.2, < 2.0)
|
||||
mime-types (>= 1.16, < 3.0)
|
||||
netrc (~> 0.7)
|
||||
rspec (3.3.0)
|
||||
rspec-core (~> 3.3.0)
|
||||
rspec-expectations (~> 3.3.0)
|
||||
rspec-mocks (~> 3.3.0)
|
||||
rspec-core (3.3.2)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-expectations (3.3.1)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.5.0)
|
||||
rspec-mocks (3.5.0)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-mocks (3.3.2)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.5.0)
|
||||
rspec-support (3.5.0)
|
||||
rubocop (0.41.2)
|
||||
parser (>= 2.3.1.1, < 3.0)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-support (3.3.0)
|
||||
rubocop (0.32.1)
|
||||
astrolabe (~> 1.3)
|
||||
parser (>= 2.2.2.5, < 3.0)
|
||||
powerpack (~> 0.1)
|
||||
rainbow (>= 1.99.1, < 3.0)
|
||||
ruby-progressbar (~> 1.7)
|
||||
unicode-display_width (~> 1.0, >= 1.0.1)
|
||||
ruby-progressbar (1.8.1)
|
||||
simplecov (0.12.0)
|
||||
ruby-progressbar (~> 1.4)
|
||||
ruby-progressbar (1.7.5)
|
||||
simplecov (0.10.0)
|
||||
docile (~> 1.1.0)
|
||||
json (>= 1.8, < 3)
|
||||
json (~> 1.8)
|
||||
simplecov-html (~> 0.10.0)
|
||||
simplecov-html (0.10.0)
|
||||
term-ansicolor (1.3.2)
|
||||
tins (~> 1.0)
|
||||
thor (0.19.1)
|
||||
thread_safe (0.3.5)
|
||||
tins (1.6.0)
|
||||
unicode-display_width (1.1.0)
|
||||
tins (1.5.4)
|
||||
unf (0.1.4)
|
||||
unf_ext
|
||||
unf_ext (0.0.7.1)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
bundler
|
||||
bundler (~> 1.7)
|
||||
codeclimate-test-reporter (~> 0.4)
|
||||
coveralls (~> 0.8)
|
||||
github_changelog_generator!
|
||||
json (< 2.0)
|
||||
overcommit
|
||||
rake
|
||||
rspec (>= 3.2)
|
||||
rubocop
|
||||
rake (~> 10.0)
|
||||
rspec (~> 3.2)
|
||||
rubocop (~> 0.31)
|
||||
simplecov (~> 0.10)
|
||||
|
||||
BUNDLED WITH
|
||||
1.12.5
|
||||
1.10.6
|
||||
|
||||
9
LICENSE
9
LICENSE
@@ -1,9 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
Copyright (c) 2016 Petr Korolev
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
144
README.md
144
README.md
@@ -21,7 +21,7 @@ GitHub Changelog Generator 
|
||||
- [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.
|
||||
|
||||
@@ -32,7 +32,7 @@ To make it easier for users and contributors to see precisely what notable chang
|
||||
### *Why should I care?*
|
||||
Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
||||
|
||||
> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
|
||||
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -45,7 +45,7 @@ Because software tools are for people. If you don’t care, why are you contribu
|
||||
|
||||
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)
|
||||
>
|
||||
@@ -67,30 +67,25 @@ Because software tools are for people. If you don’t care, why are you contribu
|
||||
|
||||
|
||||
## Usage
|
||||
**It's really simple!**
|
||||
**It's really simple**:
|
||||
|
||||
- If your **`git remote`** `origin` refers to your GitHub repo, 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
|
||||
|
||||
- Or, run this from anywhere:
|
||||
- or from anywhere:
|
||||
- `github_changelog_generator -u github_username -p github_project`
|
||||
- `github_changelog_generator github_username/github_project`
|
||||
|
||||
- If you are running it against a repository on a Github Enterprise install, you must specify *both* `--github-site` and `--github-api` command line options:
|
||||
|
||||
github_changelog_generator --github-site="https://github.yoursite.com" \
|
||||
--github-api="https://github.yoursite.com/api/v3/"
|
||||
|
||||
This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
|
||||
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||
|
||||
### Params
|
||||
Type `github_changelog_generator --help` for details.
|
||||
|
||||
For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
||||
More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
||||
|
||||
### Params File
|
||||
In your project root, you can put a params file named `.github_changelog_generator` to override default params:
|
||||
You can put Params in a .github_changelog_generator file in Project Root to override default params:
|
||||
|
||||
Example:
|
||||
```
|
||||
@@ -101,139 +96,132 @@ since-tag=1.0.0
|
||||
|
||||
### GitHub token
|
||||
|
||||
GitHub only allows only 50 unauthenticated requests per hour.
|
||||
Therefore, it's recommended to run this script with authentication by using a **token**.
|
||||
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
||||
|
||||
Here's how:
|
||||
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
|
||||
|
||||
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
|
||||
- Either:
|
||||
- Run the script with `--token <your-40-digit-token>`; **OR**
|
||||
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
|
||||
And:
|
||||
|
||||
You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
|
||||
- Run with key `-t [your-40-digit-token]`
|
||||
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
||||
|
||||
export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
|
||||
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
||||
|
||||
So, if you got an error like this:
|
||||
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
||||
|
||||
So, if you got error like this:
|
||||
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
||||
|
||||
It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
|
||||
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||
|
||||
## Migrating from a manual changelog
|
||||
|
||||
Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
|
||||
But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
|
||||
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.
|
||||
|
||||
That's where `--base <your-manual-changelog.md>` comes in handy!
|
||||
This option lets append your old manual changelog to the end of the generated entries.
|
||||
That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
|
||||
|
||||
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
|
||||
|
||||
### Rake task
|
||||
|
||||
You love `rake`? We do, too! So, we've made it even easier for you:
|
||||
we've provided a `rake` task library for your changelog generation.
|
||||
|
||||
Just put something like this in your `Rakefile`:
|
||||
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:
|
||||
|
||||
```ruby
|
||||
require 'github_changelog_generator/task'
|
||||
|
||||
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
||||
config.since_tag = '0.1.14'
|
||||
config.future_release = '0.2.0'
|
||||
end
|
||||
```
|
||||
|
||||
All command line options can be passed to the `rake` task as `config` parameters. And since you're naming the `rake` task yourself, you can create as many as you want.
|
||||
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.
|
||||
|
||||
## Features and advantages of this project
|
||||
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
|
||||
- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
||||
##Features and advantages of this project
|
||||
- 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:
|
||||
- **GitHub Enterprise support** via command line options! :factory:
|
||||
- Flexible format **customization**:
|
||||
- **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
|
||||
- **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
|
||||
- Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
|
||||
- Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
|
||||
- **Distinguish** issues **by labels**. :mag_right:
|
||||
- Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
|
||||
- Bug fixes (issues labeled `bug`) :beetle:
|
||||
- Enhancements (issues labeled `enhancement`) :star2:
|
||||
- Issues (closed issues with no labels) :non-potable_water:
|
||||
- Flexible format **customisation**:
|
||||
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
|
||||
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
|
||||
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version :pushpin:
|
||||
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
|
||||
- **Distinguish** issues **according labels**. :mag_right:
|
||||
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
|
||||
- Bug fixes (by label `bug` in issue) :beetle:
|
||||
- Enhancements (by label `enhancement` in issue) :star2:
|
||||
- Issues (closed issues `w/o any labels`) :non-potable_water:
|
||||
|
||||
- Manually include or exclude issues by labels :wrench:
|
||||
- Customize lots more! Tweak the changelog to fit your preferences :tophat:
|
||||
(*See `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.
|
||||
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!*
|
||||
*If you know other projects - feel free to edit this Wiki page!*
|
||||
|
||||
|
||||
### Projects using this library
|
||||
Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
|
||||
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
||||
|
||||
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
|
||||
|
||||
*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
|
||||
*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?
|
||||
|
||||
- **Nothing is impossible!**
|
||||
|
||||
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the 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, and well-wishes are always welcome.* :heavy_exclamation_mark:
|
||||
- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
|
||||
|
||||
## FAQ
|
||||
|
||||
- ***I already use GitHub Releases. Why do I need this?***
|
||||
|
||||
GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are 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:
|
||||
|
||||
*BTW: 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 trying to compare the quality of handwritten and auto-generated logs. That said....
|
||||
I'm not try to compare quality of auto-generated and manually generated logs.. but:
|
||||
|
||||
An auto-generated changelog really helps, even if you manually fill in the release notes!
|
||||
The auto generated Changelog really helps even if you manually fill Releases notes!
|
||||
|
||||
For example:
|
||||
|
||||
When I found a closed bug, it's very useful know which release fixed it.
|
||||
In this case, you can easily find the 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 quite as easy to find this in handwritten releases notes
|
||||
- a generated file saves you the trouble of remembering everything;
|
||||
sometimes people forget to add things to a handwritten file
|
||||
- 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.
|
||||
|
||||
Ultimately, I think GitHub Releases is ideal for end-users.
|
||||
Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
|
||||
Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
|
||||
In the end:
|
||||
|
||||
- ***I received a warning: "GitHub API rate limit exceed" What does this mean?***
|
||||
I think, that GitHub Releases is more for end-users.
|
||||
But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
|
||||
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
|
||||
|
||||
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 is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
|
||||
- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
|
||||
|
||||
If you're seeing this warning, please do the following:
|
||||
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.
|
||||
|
||||
1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
|
||||
2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
||||
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.
|
||||
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
|
||||
|
||||
1. Create an issue and describe your idea
|
||||
1. Create an issue to discuss about your idea
|
||||
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
||||
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
5. Publish 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
|
||||
7. Profit! :white_check_mark:
|
||||
|
||||
*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
|
||||
*To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
|
||||
|
||||
## License
|
||||
|
||||
|
||||
34
Rakefile
34
Rakefile
@@ -1,39 +1,7 @@
|
||||
require "bundler"
|
||||
require "bundler/gem_tasks"
|
||||
require "rubocop/rake_task"
|
||||
require "rspec/core/rake_task"
|
||||
require "pathname"
|
||||
require "fileutils"
|
||||
require "overcommit"
|
||||
|
||||
RuboCop::RakeTask.new
|
||||
RSpec::Core::RakeTask.new(:rspec)
|
||||
|
||||
task :copy_man_page_to_manpath do |_t|
|
||||
known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
|
||||
manpath = known_manpath_paths.find do |f|
|
||||
path = Pathname(f)
|
||||
path.file? && path.readable?
|
||||
end
|
||||
|
||||
next unless manpath
|
||||
|
||||
writable_man_path = Pathname(manpath).each_line.find do |line|
|
||||
path = Pathname(line.chomp)
|
||||
path.directory? && path.writable?
|
||||
end
|
||||
|
||||
next unless writable_man_path
|
||||
|
||||
man_prefix = Pathname("#{writable_man_path.chomp}/man1")
|
||||
man_pages = "man/git-*.1"
|
||||
|
||||
Pathname.glob(man_pages) do |path|
|
||||
if path.exist? && man_prefix.exist? && man_prefix.writable?
|
||||
FileUtils.cp(path, man_prefix + path.basename)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
task checks: [:rubocop, :rspec]
|
||||
task default: [:copy_man_page_to_manpath]
|
||||
task default: [:rubocop, :rspec]
|
||||
|
||||
50
appveyor.yml
50
appveyor.yml
@@ -1,50 +0,0 @@
|
||||
version: "{build}"
|
||||
|
||||
platform: x64
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
|
||||
clone_depth: 10
|
||||
|
||||
skip_tags: true
|
||||
|
||||
# See here for Ruby versions pre-installed:
|
||||
# http://www.appveyor.com/docs/installed-software#ruby
|
||||
environment:
|
||||
matrix:
|
||||
- ruby_version: "21" # Older version, but matches Travis-CI
|
||||
- ruby_version: "21-x64"
|
||||
|
||||
install:
|
||||
- SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
|
||||
|
||||
# Print version and location for pre-installed ruby
|
||||
- ruby --version
|
||||
- where ruby
|
||||
|
||||
# Install latest version of RubyGems
|
||||
- gem update --system --no-document --no-post-install-message
|
||||
- gem --version
|
||||
- where gem
|
||||
|
||||
# Print version and location for pre-installed bundler
|
||||
- bundler --version
|
||||
- where bundler
|
||||
|
||||
build_script:
|
||||
# Install ruby dependencies
|
||||
- bundle install --retry 3
|
||||
- bundle exec rake checks
|
||||
|
||||
test_script:
|
||||
- gem build github_changelog_generator
|
||||
- gem install *.gem
|
||||
|
||||
notifications:
|
||||
- provider: Email
|
||||
to:
|
||||
- sky4winder+githubchangeloggenerator@gmail.com
|
||||
on_build_success: false
|
||||
on_build_status_changed: true
|
||||
10
ext/mkrf_conf.rb
Normal file
10
ext/mkrf_conf.rb
Normal file
@@ -0,0 +1,10 @@
|
||||
PREFIX = "/usr/local"
|
||||
MANPREFIX = "#{PREFIX}/share/man/man1"
|
||||
MAN_PAGES = "man/git-*"
|
||||
|
||||
require "fileutils"
|
||||
|
||||
Dir.glob(MAN_PAGES).each do |f|
|
||||
filename = File.basename(f)
|
||||
FileUtils.cp(f, "#{MANPREFIX}/#{filename}")
|
||||
end
|
||||
@@ -1,4 +1,5 @@
|
||||
# coding: utf-8
|
||||
|
||||
lib = File.expand_path("../lib", __FILE__)
|
||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||
require "github_changelog_generator/version"
|
||||
@@ -8,27 +9,25 @@ Gem::Specification.new do |spec|
|
||||
spec.version = GitHubChangelogGenerator::VERSION
|
||||
spec.default_executable = "github_changelog_generator"
|
||||
|
||||
spec.required_ruby_version = ">= 1.9.3"
|
||||
spec.authors = ["Petr Korolev", "Olle Jonsson"]
|
||||
spec.required_ruby_version = ">= 1.9.3"
|
||||
spec.authors = ["Petr Korolev"]
|
||||
spec.email = "sky4winder+github_changelog_generator@gmail.com"
|
||||
|
||||
spec.date = `date +"%Y-%m-%d"`.strip!
|
||||
spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
|
||||
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
|
||||
spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
|
||||
spec.license = "MIT"
|
||||
|
||||
spec.files = Dir["{bin,lib,man,spec}/**/*"] + %w(LICENSE Rakefile README.md)
|
||||
spec.license = "MIT"
|
||||
spec.extensions = "ext/mkrf_conf.rb"
|
||||
|
||||
spec.files = `git ls-files -z`.split("\x0")
|
||||
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||
spec.require_paths = ["lib"]
|
||||
|
||||
spec.add_runtime_dependency "rake", ">= 10.0"
|
||||
spec.add_runtime_dependency "github_api", ">= 0.12"
|
||||
spec.add_runtime_dependency "colorize", ">= 0.7"
|
||||
spec.add_runtime_dependency("github_api", ["~> 0.12"])
|
||||
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
||||
|
||||
spec.add_development_dependency "overcommit", ">= 0.31"
|
||||
spec.add_development_dependency "rspec", ">= 3.2"
|
||||
spec.add_development_dependency "bundler", ">= 1.7"
|
||||
spec.add_development_dependency "rubocop", ">= 0.31"
|
||||
# Development only
|
||||
spec.add_development_dependency "bundler", "~> 1.7"
|
||||
spec.add_development_dependency "rake", "~> 10.0"
|
||||
end
|
||||
|
||||
@@ -22,7 +22,6 @@
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
|
||||
- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
|
||||
- This 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))
|
||||
|
||||
@@ -28,7 +28,7 @@ module GitHubChangelogGenerator
|
||||
def run
|
||||
log = @generator.compound_changelog
|
||||
|
||||
output_filename = (@options[:output]).to_s
|
||||
output_filename = "#{@options[:output]}"
|
||||
File.open(output_filename, "w") { |file| file.write(log) }
|
||||
puts "Done!"
|
||||
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
||||
|
||||
@@ -18,12 +18,12 @@ module GitHubChangelogGenerator
|
||||
@user = @options[:user]
|
||||
@project = @options[:project]
|
||||
@github_token = fetch_github_token
|
||||
@github_options = { per_page: PER_PAGE_NUMBER }
|
||||
@github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||
@github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
|
||||
@github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
|
||||
github_options = { per_page: PER_PAGE_NUMBER }
|
||||
github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||
github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
|
||||
github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
|
||||
|
||||
@github = check_github_response { Github.new @github_options }
|
||||
@github = check_github_response { Github.new github_options }
|
||||
end
|
||||
|
||||
# Returns GitHub token. First try to use variable, provided by --token option,
|
||||
@@ -71,7 +71,7 @@ module GitHubChangelogGenerator
|
||||
response.each_page do |page|
|
||||
page_i += PER_PAGE_NUMBER
|
||||
print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
|
||||
tags.concat(page) unless page.nil?
|
||||
tags.concat(page)
|
||||
end
|
||||
print_empty_line
|
||||
|
||||
@@ -123,16 +123,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||
def fetch_closed_pull_requests
|
||||
pull_requests = []
|
||||
begin
|
||||
response = if @options[:release_branch].nil?
|
||||
@github.pull_requests.list @options[:user],
|
||||
@options[:project],
|
||||
state: "closed"
|
||||
else
|
||||
@github.pull_requests.list @options[:user],
|
||||
@options[:project],
|
||||
state: "closed",
|
||||
base: @options[:release_branch]
|
||||
end
|
||||
response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
|
||||
page_i = 0
|
||||
count_pages = response.count_pages
|
||||
response.each_page do |page|
|
||||
|
||||
@@ -8,15 +8,13 @@ module GitHubChangelogGenerator
|
||||
sort_tags_by_date(@filtered_tags)
|
||||
fetch_issues_and_pr
|
||||
|
||||
log = ""
|
||||
log += @options[:frontmatter] if @options[:frontmatter]
|
||||
log += "#{@options[:header]}\n\n"
|
||||
log = "#{@options[:header]}\n\n"
|
||||
|
||||
log += if @options[:unreleased_only]
|
||||
generate_log_between_tags(filtered_tags[0], nil)
|
||||
else
|
||||
generate_log_for_all_tags
|
||||
end
|
||||
if @options[:unreleased_only]
|
||||
log += generate_log_between_tags(filtered_tags[0], nil)
|
||||
else
|
||||
log += generate_log_for_all_tags
|
||||
end
|
||||
|
||||
log += File.read(@options[:base]) if File.file?(@options[:base])
|
||||
|
||||
@@ -39,10 +37,10 @@ module GitHubChangelogGenerator
|
||||
index2 = hash[tag2]
|
||||
log += generate_log_between_tags(all_tags[index1], all_tags[index2])
|
||||
else
|
||||
raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
|
||||
fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
|
||||
end
|
||||
else
|
||||
raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
|
||||
fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
|
||||
end
|
||||
log
|
||||
end
|
||||
@@ -79,16 +77,16 @@ module GitHubChangelogGenerator
|
||||
time_string = newer_tag_time.strftime @options[:date_format]
|
||||
|
||||
# Generate tag name and link
|
||||
release_url = if @options[:release_url]
|
||||
format(@options[:release_url], newer_tag_link)
|
||||
else
|
||||
"#{project_url}/tree/#{newer_tag_link}"
|
||||
end
|
||||
log += if newer_tag_name.equal? @options[:unreleased_label]
|
||||
"## [#{newer_tag_name}](#{release_url})\n\n"
|
||||
else
|
||||
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
|
||||
end
|
||||
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]
|
||||
log += "## [#{newer_tag_name}](#{release_url})\n\n"
|
||||
else
|
||||
log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
|
||||
end
|
||||
|
||||
if @options[:compare_link] && older_tag_link
|
||||
# Generate compare link
|
||||
@@ -160,7 +158,7 @@ module GitHubChangelogGenerator
|
||||
# Parse issue and generate single line formatted issue line.
|
||||
#
|
||||
# Example output:
|
||||
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
|
||||
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
||||
#
|
||||
# @param [Hash] issue Fetched issue from GitHub
|
||||
# @return [String] Markdown-formatted single issue
|
||||
@@ -168,22 +166,17 @@ module GitHubChangelogGenerator
|
||||
encapsulated_title = encapsulate_string issue[:title]
|
||||
|
||||
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
|
||||
issue_line_with_user(title_with_number, issue)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def issue_line_with_user(line, issue)
|
||||
return line if !@options[:author] || issue.pull_request.nil?
|
||||
|
||||
user = issue.user
|
||||
return "#{line} ({Null user})" unless user
|
||||
|
||||
if @options[:usernames_as_github_logins]
|
||||
"#{line} (@#{user.login})"
|
||||
else
|
||||
"#{line} ([#{user.login}](#{user.html_url}))"
|
||||
unless issue.pull_request.nil?
|
||||
if @options[:author]
|
||||
if issue.user.nil?
|
||||
title_with_number += " ({Null user})"
|
||||
else
|
||||
title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
|
||||
end
|
||||
end
|
||||
end
|
||||
title_with_number
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -4,12 +4,13 @@ module GitHubChangelogGenerator
|
||||
# @param [Array] issues
|
||||
# @return [Array] filtered array
|
||||
def exclude_issues_by_labels(issues)
|
||||
return issues if !@options[:exclude_labels] || @options[:exclude_labels].empty?
|
||||
|
||||
issues.reject do |issue|
|
||||
labels = issue.labels.map(&:name)
|
||||
(labels & @options[:exclude_labels]).any?
|
||||
unless @options[:exclude_labels].nil?
|
||||
issues = issues.select do |issue|
|
||||
var = issue.labels.map(&:name) & @options[:exclude_labels]
|
||||
!(var).any?
|
||||
end
|
||||
end
|
||||
issues
|
||||
end
|
||||
|
||||
# @return [Array] filtered issues accourding milestone
|
||||
@@ -82,7 +83,7 @@ module GitHubChangelogGenerator
|
||||
|
||||
tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
|
||||
|
||||
tag_in_range = tag_in_range_old && tag_in_range_new
|
||||
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
||||
|
||||
tag_in_range
|
||||
else
|
||||
@@ -92,20 +93,20 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
|
||||
def tag_older_new_tag?(newer_tag_time, time)
|
||||
tag_in_range_new = if newer_tag_time.nil?
|
||||
true
|
||||
else
|
||||
time <= newer_tag_time
|
||||
end
|
||||
if newer_tag_time.nil?
|
||||
tag_in_range_new = true
|
||||
else
|
||||
tag_in_range_new = time <= newer_tag_time
|
||||
end
|
||||
tag_in_range_new
|
||||
end
|
||||
|
||||
def tag_newer_old_tag?(older_tag_time, t)
|
||||
tag_in_range_old = if older_tag_time.nil?
|
||||
true
|
||||
else
|
||||
t > older_tag_time
|
||||
end
|
||||
if older_tag_time.nil?
|
||||
tag_in_range_old = true
|
||||
else
|
||||
tag_in_range_old = t > older_tag_time
|
||||
end
|
||||
tag_in_range_old
|
||||
end
|
||||
|
||||
@@ -132,7 +133,7 @@ module GitHubChangelogGenerator
|
||||
def filter_by_include_labels(issues)
|
||||
filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
|
||||
labels = issue.labels.map(&:name) & @options[:include_labels]
|
||||
labels.any?
|
||||
(labels).any?
|
||||
end
|
||||
filtered_issues
|
||||
end
|
||||
@@ -177,10 +178,8 @@ module GitHubChangelogGenerator
|
||||
fetched_pr = closed_pull_requests.find do |fpr|
|
||||
fpr.number == pr.number
|
||||
end
|
||||
if fetched_pr
|
||||
pr[:merged_at] = fetched_pr[:merged_at]
|
||||
closed_pull_requests.delete(fetched_pr)
|
||||
end
|
||||
pr[:merged_at] = fetched_pr[:merged_at]
|
||||
closed_pull_requests.delete(fetched_pr)
|
||||
end
|
||||
|
||||
pull_requests.select! do |pr|
|
||||
|
||||
@@ -19,7 +19,7 @@ module GitHubChangelogGenerator
|
||||
# @param [Hash] tag_name name of the tag
|
||||
# @return [Time] time of specified tag
|
||||
def get_time_of_tag(tag_name)
|
||||
raise ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
|
||||
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]
|
||||
@@ -54,14 +54,13 @@ module GitHubChangelogGenerator
|
||||
|
||||
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
|
||||
def detect_since_tag
|
||||
@since_tag ||= @options.fetch(:since_tag) { version_of_first_item }
|
||||
end
|
||||
|
||||
def version_of_first_item
|
||||
return unless File.file?(@options[:base].to_s)
|
||||
|
||||
sections = GitHubChangelogGenerator::Reader.new.read(@options[:base])
|
||||
sections.first["version"] if sections && sections.any?
|
||||
@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
|
||||
@@ -81,11 +80,11 @@ module GitHubChangelogGenerator
|
||||
if tag
|
||||
if all_tags.map(&:name).include? tag
|
||||
idx = all_tags.index { |t| t.name == tag }
|
||||
filtered_tags = if idx > 0
|
||||
all_tags[0..idx - 1]
|
||||
else
|
||||
[]
|
||||
end
|
||||
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
|
||||
@@ -102,11 +101,11 @@ module GitHubChangelogGenerator
|
||||
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
|
||||
filtered_tags = if idx > 0 && idx < last_index
|
||||
all_tags[idx + 1..last_index]
|
||||
else
|
||||
[]
|
||||
end
|
||||
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
|
||||
@@ -130,34 +129,26 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
|
||||
# @param [Array] all_tags all tags
|
||||
# @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
|
||||
# @return [Array] filtered tags according :exclude_tags option
|
||||
def filter_excluded_tags(all_tags)
|
||||
if @options[:exclude_tags]
|
||||
apply_exclude_tags(all_tags)
|
||||
elsif @options[:exclude_tags_regex]
|
||||
apply_exclude_tags_regex(all_tags)
|
||||
else
|
||||
all_tags
|
||||
end
|
||||
return all_tags unless @options[:exclude_tags]
|
||||
|
||||
apply_exclude_tags(all_tags)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def apply_exclude_tags(all_tags)
|
||||
if @options[:exclude_tags].is_a?(Regexp)
|
||||
filter_tags_with_regex(all_tags, @options[:exclude_tags])
|
||||
filter_tags_with_regex(all_tags)
|
||||
else
|
||||
filter_exact_tags(all_tags)
|
||||
end
|
||||
end
|
||||
|
||||
def apply_exclude_tags_regex(all_tags)
|
||||
filter_tags_with_regex(all_tags, Regexp.new(@options[:exclude_tags_regex]))
|
||||
end
|
||||
|
||||
def filter_tags_with_regex(all_tags, regex)
|
||||
def filter_tags_with_regex(all_tags)
|
||||
warn_if_nonmatching_regex(all_tags)
|
||||
all_tags.reject { |tag| regex =~ tag.name }
|
||||
all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
|
||||
end
|
||||
|
||||
def filter_exact_tags(all_tags)
|
||||
|
||||
@@ -3,14 +3,14 @@ module GitHubChangelogGenerator
|
||||
module Helper
|
||||
# @return true if the currently running program is a unit test
|
||||
def self.test?
|
||||
defined? SpecHelper
|
||||
defined?SpecHelper
|
||||
end
|
||||
|
||||
@log ||= if test?
|
||||
Logger.new(nil) # don't show any logs when running tests
|
||||
else
|
||||
Logger.new(STDOUT)
|
||||
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"
|
||||
|
||||
|
||||
152
lib/github_changelog_generator/parser.rb
Executable file → Normal file
152
lib/github_changelog_generator/parser.rb
Executable file → Normal file
@@ -7,28 +7,29 @@ module GitHubChangelogGenerator
|
||||
class Parser
|
||||
# parse options with optparse
|
||||
def self.parse_options
|
||||
options = default_options
|
||||
options = get_default_options
|
||||
|
||||
ParserFile.new(options).parse!
|
||||
parser_file = ParserFile.new options
|
||||
parser_file.parse!
|
||||
|
||||
parser = setup_parser(options)
|
||||
parser.parse!
|
||||
|
||||
fetch_user_and_project(options)
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
detect_user_and_project(options, ARGV[0], ARGV[1])
|
||||
end
|
||||
|
||||
abort(parser.banner) unless options[:user] && options[:project]
|
||||
if !options[:user] || !options[:project]
|
||||
puts parser.banner
|
||||
exit
|
||||
end
|
||||
|
||||
print_options(options)
|
||||
|
||||
options
|
||||
end
|
||||
|
||||
# If options set to verbose, print the parsed options.
|
||||
#
|
||||
# The GitHub `:token` key is censored in the output.
|
||||
#
|
||||
# @param options [Hash] The options to display
|
||||
# @option options [Boolean] :verbose If false this method does nothing
|
||||
# @param [Hash] options to display
|
||||
def self.print_options(options)
|
||||
if options[:verbose]
|
||||
Helper.log.info "Performing task with options:"
|
||||
@@ -61,7 +62,7 @@ module GitHubChangelogGenerator
|
||||
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|
|
||||
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|
|
||||
@@ -73,9 +74,6 @@ module GitHubChangelogGenerator
|
||||
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
|
||||
options[:header] = v
|
||||
end
|
||||
opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
|
||||
options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
|
||||
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
|
||||
@@ -97,9 +95,6 @@ module GitHubChangelogGenerator
|
||||
opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
|
||||
options[:author] = author
|
||||
end
|
||||
opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
|
||||
options[:usernames_as_github_logins] = v
|
||||
end
|
||||
opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
|
||||
options[:unreleased_only] = v
|
||||
end
|
||||
@@ -130,9 +125,6 @@ module GitHubChangelogGenerator
|
||||
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
|
||||
options[:exclude_tags] = list
|
||||
end
|
||||
opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
|
||||
options[:exclude_tags_regex] = last
|
||||
end
|
||||
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
|
||||
options[:since_tag] = v
|
||||
end
|
||||
@@ -157,9 +149,6 @@ module GitHubChangelogGenerator
|
||||
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
|
||||
options[:future_release] = future_release
|
||||
end
|
||||
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
|
||||
options[:release_branch] = release_branch
|
||||
end
|
||||
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
|
||||
options[:verbose] = v
|
||||
end
|
||||
@@ -175,9 +164,9 @@ module GitHubChangelogGenerator
|
||||
parser
|
||||
end
|
||||
|
||||
# @return [Hash] Default options
|
||||
def self.default_options
|
||||
{
|
||||
# just get default options
|
||||
def self.get_default_options
|
||||
options = {
|
||||
tag1: nil,
|
||||
tag2: nil,
|
||||
date_format: "%Y-%m-%d",
|
||||
@@ -205,66 +194,45 @@ module GitHubChangelogGenerator
|
||||
enhancement_prefix: "**Implemented enhancements:**",
|
||||
git_remote: "origin"
|
||||
}
|
||||
|
||||
options
|
||||
end
|
||||
|
||||
# If `:user` or `:project` not set in options, try setting them
|
||||
# Valid unnamed parameters:
|
||||
# 1) in 1 param: repo_name/project
|
||||
# 2) in 2 params: repo name project
|
||||
def self.fetch_user_and_project(options)
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
|
||||
options[:user] ||= user
|
||||
options[:project] ||= project
|
||||
end
|
||||
end
|
||||
|
||||
# Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
|
||||
# @param [String] arg0 first argument in cli
|
||||
# @param [String] arg1 second argument in cli
|
||||
# @return [Array<String>] user and project, or nil if unsuccessful
|
||||
def self.user_and_project_from_git(options, arg0 = nil, arg1 = nil)
|
||||
user, project = user_project_from_option(arg0, arg1, options[:github_site])
|
||||
unless user && project
|
||||
# Detects user and project from git
|
||||
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
|
||||
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
|
||||
if !options[:user] || !options[:project]
|
||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||
user = "skywinder"
|
||||
project = "changelog_test"
|
||||
options[:user] = "skywinder"
|
||||
options[:project] = "changelog_test"
|
||||
else
|
||||
remote = `git config --get remote.#{options[:git_remote]}.url`
|
||||
user, project = user_project_from_remote(remote)
|
||||
options[:user], options[:project] = user_project_from_remote(remote)
|
||||
end
|
||||
end
|
||||
|
||||
[user, project]
|
||||
end
|
||||
|
||||
# Returns GitHub username and project from CLI arguments
|
||||
# Try to find user and project name from git remote output
|
||||
#
|
||||
# @param arg0 [String] This parameter takes two forms: Either a full
|
||||
# GitHub URL, or a 'username/projectname', or
|
||||
# simply a GitHub username
|
||||
# @param arg1 [String] If arg0 is given as a username,
|
||||
# then arg1 can given as a projectname
|
||||
# @param github_site [String] Domain name of GitHub site
|
||||
#
|
||||
# @return [Array, nil] user and project, or nil if unsuccessful
|
||||
def self.user_project_from_option(arg0, arg1, github_site)
|
||||
# @param [String] output of git remote command
|
||||
# @return [Array] user and project
|
||||
def self.user_project_from_option(arg0, arg1, github_site = nil)
|
||||
user = nil
|
||||
project = nil
|
||||
github_site ||= "github.com"
|
||||
if arg0 && !arg1
|
||||
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or
|
||||
# "skywinder/Github-Changelog-Generator" to user and name
|
||||
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
|
||||
puts arg0
|
||||
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
|
||||
|
||||
begin
|
||||
param = match[2].nil?
|
||||
rescue
|
||||
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
|
||||
return
|
||||
exit
|
||||
end
|
||||
if param
|
||||
return
|
||||
exit
|
||||
else
|
||||
user = match[1]
|
||||
project = match[2]
|
||||
@@ -273,43 +241,43 @@ module GitHubChangelogGenerator
|
||||
[user, project]
|
||||
end
|
||||
|
||||
# These patterns match these formats:
|
||||
#
|
||||
# ```
|
||||
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
|
||||
# git@github.com:skywinder/Github-Changelog-Generator.git
|
||||
# ```
|
||||
#
|
||||
# and
|
||||
#
|
||||
# ```
|
||||
# origin https://github.com/skywinder/ChangelogMerger (fetch)
|
||||
# https://github.com/skywinder/ChangelogMerger
|
||||
# ```
|
||||
GIT_REMOTE_PATTERNS = [
|
||||
/.*(?:[:\/])(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*)(?:\.git).*/,
|
||||
/.*\/(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*).*/
|
||||
]
|
||||
|
||||
# Returns GitHub username and project from git remote output
|
||||
#
|
||||
# @param git_remote_output [String] Output of git remote command
|
||||
# Try to find user and project name from git remote output
|
||||
#
|
||||
# @param [String] output of git remote command
|
||||
# @return [Array] user and project
|
||||
def self.user_project_from_remote(git_remote_output)
|
||||
def self.user_project_from_remote(remote)
|
||||
# try to find repo in format:
|
||||
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
|
||||
# git@github.com:skywinder/Github-Changelog-Generator.git
|
||||
regex1 = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/
|
||||
|
||||
# try to find repo in format:
|
||||
# origin https://github.com/skywinder/ChangelogMerger (fetch)
|
||||
# https://github.com/skywinder/ChangelogMerger
|
||||
regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/
|
||||
|
||||
remote_structures = [regex1, regex2]
|
||||
|
||||
user = nil
|
||||
project = nil
|
||||
GIT_REMOTE_PATTERNS.each do |git_remote_pattern|
|
||||
git_remote_pattern =~ git_remote_output
|
||||
remote_structures.each do |regex|
|
||||
matches = Regexp.new(regex).match(remote)
|
||||
|
||||
if Regexp.last_match
|
||||
user = Regexp.last_match(:user)
|
||||
project = Regexp.last_match(:project)
|
||||
break
|
||||
if matches && matches[1] && matches[2]
|
||||
puts "Detected user:#{matches[1]}, project:#{matches[2]}"
|
||||
user = matches[1]
|
||||
project = matches[2]
|
||||
end
|
||||
|
||||
break unless matches.nil?
|
||||
end
|
||||
|
||||
[user, project]
|
||||
end
|
||||
end
|
||||
|
||||
if __FILE__ == $PROGRAM_NAME
|
||||
remote = "invalid reference to project"
|
||||
p user_project_from_option(ARGV[0], ARGV[1], remote)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,61 +1,31 @@
|
||||
require "pathname"
|
||||
|
||||
module GitHubChangelogGenerator
|
||||
ParserError = Class.new(StandardError)
|
||||
|
||||
# ParserFile is a configuration file reader which sets options in the
|
||||
# given Hash.
|
||||
#
|
||||
# In your project's root, you can put a file named
|
||||
# <tt>.github_changelog_generator</tt> to override defaults.
|
||||
#
|
||||
# Example:
|
||||
# header_label=# My Super Changelog
|
||||
# ; Comments are allowed
|
||||
# future-release=5.0.0
|
||||
# # Ruby-style comments, too
|
||||
# since-tag=1.0.0
|
||||
#
|
||||
# The configuration format is <tt>some-key=value</tt> or <tt>some_key=value</tt>.
|
||||
#
|
||||
class ParserFile
|
||||
# @param options [Hash] options to be configured from file contents
|
||||
# @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
|
||||
def initialize(options, file = open_settings_file)
|
||||
def initialize(options)
|
||||
@options = options
|
||||
@file = file
|
||||
end
|
||||
|
||||
# Sets options using configuration file content
|
||||
def parse!
|
||||
return unless @file
|
||||
@file.each_with_index { |line, i| parse_line!(line, i + 1) }
|
||||
@file.close
|
||||
return unless File.exist?(file)
|
||||
|
||||
File.readlines(file).each { |line| parse_line!(line) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
FILENAME = ".github_changelog_generator"
|
||||
|
||||
def open_settings_file
|
||||
path = Pathname(File.expand_path(FILENAME))
|
||||
File.open(path) if path.exist?
|
||||
def file
|
||||
@file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
|
||||
end
|
||||
|
||||
def parse_line!(line, line_number)
|
||||
return if non_configuration_line?(line)
|
||||
option_name, value = extract_pair(line)
|
||||
@options[option_key_for(option_name)] = convert_value(value, option_name)
|
||||
def parse_line!(line)
|
||||
key_sym, value = extract_pair(line)
|
||||
value = true if value =~ (/^(true|t|yes|y|1)$/i)
|
||||
value = false if value =~ (/^(false|f|no|n|0)$/i)
|
||||
@options[key_sym] = value
|
||||
rescue
|
||||
raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
|
||||
raise "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
|
||||
end
|
||||
|
||||
# Returns true if the line starts with a pound sign or a semi-colon.
|
||||
def non_configuration_line?(line)
|
||||
line =~ /^[\#;]/ || line =~ /^[\s]+$/
|
||||
end
|
||||
|
||||
# Returns a the option name as a symbol and its string value sans newlines.
|
||||
# Returns a the setting as a symbol and its string value sans newlines.
|
||||
#
|
||||
# @param line [String] unparsed line from config file
|
||||
# @return [Array<Symbol, String>]
|
||||
@@ -63,41 +33,5 @@ module GitHubChangelogGenerator
|
||||
key, value = line.split("=", 2)
|
||||
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
|
||||
end
|
||||
|
||||
KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
|
||||
:enhancement_labels, :between_tags, :exclude_tags]
|
||||
KNOWN_INTEGER_KEYS = [:max_issues]
|
||||
|
||||
def convert_value(value, option_name)
|
||||
if KNOWN_ARRAY_KEYS.include?(option_name)
|
||||
value.split(",")
|
||||
elsif KNOWN_INTEGER_KEYS.include?(option_name)
|
||||
value.to_i
|
||||
elsif value =~ /^(true|t|yes|y|1)$/i
|
||||
true
|
||||
elsif value =~ /^(false|f|no|n|0)$/i
|
||||
false
|
||||
else
|
||||
value
|
||||
end
|
||||
end
|
||||
|
||||
IRREGULAR_OPTIONS = {
|
||||
bugs_label: :bug_prefix,
|
||||
enhancement_label: :enhancement_prefix,
|
||||
issues_label: :issue_prefix,
|
||||
header_label: :header,
|
||||
front_matter: :frontmatter,
|
||||
pr_label: :merge_prefix,
|
||||
issues_wo_labels: :add_issues_wo_labels,
|
||||
pr_wo_labels: :add_pr_wo_labels,
|
||||
pull_requests: :pulls,
|
||||
filter_by_milestone: :filter_issues_by_milestone,
|
||||
github_api: :github_endpoint
|
||||
}
|
||||
|
||||
def option_key_for(option_name)
|
||||
IRREGULAR_OPTIONS.fetch(option_name) { option_name }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -53,28 +53,31 @@ module GitHubChangelogGenerator
|
||||
|
||||
@heading_structures.each do |regexp|
|
||||
matches = Regexp.new(regexp).match(heading)
|
||||
if matches
|
||||
captures.merge!(Hash[matches.names.zip(matches.captures)])
|
||||
break
|
||||
end
|
||||
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
|
||||
|
||||
# Try Regular Expressions until you find one that delivers results
|
||||
break unless matches.nil?
|
||||
end
|
||||
|
||||
captures
|
||||
end
|
||||
|
||||
# Parse the given ChangeLog data into a list of Hashes
|
||||
# Parse the given ChangeLog data into a Hash
|
||||
#
|
||||
# @param [String] data File data from the ChangeLog.md
|
||||
# @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
||||
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
||||
def parse(data)
|
||||
sections = data.split(/^## .+?$/)
|
||||
headings = data.scan(/^## .+?$/)
|
||||
changelog = []
|
||||
|
||||
headings.each_with_index.map do |heading, index|
|
||||
section = parse_heading(heading)
|
||||
section["content"] = sections.at(index + 1)
|
||||
section
|
||||
headings.each_with_index do |heading, index|
|
||||
captures = parse_heading(heading)
|
||||
captures["content"] = sections.at(index + 1)
|
||||
changelog.push captures
|
||||
end
|
||||
|
||||
changelog
|
||||
end
|
||||
|
||||
def read(file_path)
|
||||
|
||||
@@ -14,10 +14,9 @@ module GitHubChangelogGenerator
|
||||
unreleased_only unreleased unreleased_label
|
||||
compare_link include_labels exclude_labels
|
||||
bug_labels enhancement_labels
|
||||
between_tags exclude_tags exclude_tags_regex since_tag max_issues
|
||||
between_tags exclude_tags since_tag max_issues
|
||||
github_site github_endpoint simple_list
|
||||
future_release release_branch verbose release_url
|
||||
base )
|
||||
future_release verbose release_url base )
|
||||
|
||||
OPTIONS.each do |o|
|
||||
attr_accessor o.to_sym
|
||||
@@ -37,16 +36,18 @@ module GitHubChangelogGenerator
|
||||
def define(args, &task_block)
|
||||
desc "Generate a Change log from GitHub"
|
||||
|
||||
yield(*[self, args].slice(0, task_block.arity)) if task_block
|
||||
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.default_options
|
||||
options = Parser.get_default_options
|
||||
|
||||
Parser.fetch_user_and_project(options)
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
Parser.detect_user_and_project(options)
|
||||
end
|
||||
|
||||
OPTIONS.each do |o|
|
||||
v = instance_variable_get("@#{o}")
|
||||
@@ -57,7 +58,7 @@ module GitHubChangelogGenerator
|
||||
|
||||
log = generator.compound_changelog
|
||||
|
||||
output_filename = (options[:output]).to_s
|
||||
output_filename = "#{options[:output]}"
|
||||
File.open(output_filename, "w") { |file| file.write(log) }
|
||||
puts "Done!"
|
||||
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
module GitHubChangelogGenerator
|
||||
VERSION = "1.13.1"
|
||||
VERSION = "1.9.0"
|
||||
end
|
||||
|
||||
0
spec/files/github_changelog_params_empty
Normal file
0
spec/files/github_changelog_params_empty
Normal file
2
spec/files/github_changelog_params_incorrect
Normal file
2
spec/files/github_changelog_params_incorrect
Normal file
@@ -0,0 +1,2 @@
|
||||
unreleased_label: staging
|
||||
unreleased: false
|
||||
3
spec/files/github_changelog_params_override
Normal file
3
spec/files/github_changelog_params_override
Normal file
@@ -0,0 +1,3 @@
|
||||
unreleased_label=staging
|
||||
unreleased=false
|
||||
header==== Changelog ===
|
||||
@@ -1,3 +0,0 @@
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "github_changelog_generator", path: Dir.glob("../pkg/github_changelog_generator-*.gem")[0]
|
||||
@@ -23,11 +23,11 @@ require "coveralls"
|
||||
module SpecHelper
|
||||
end
|
||||
|
||||
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
|
||||
Coveralls::SimpleCov::Formatter,
|
||||
SimpleCov::Formatter::HTMLFormatter,
|
||||
CodeClimate::TestReporter::Formatter
|
||||
])
|
||||
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
||||
Coveralls::SimpleCov::Formatter,
|
||||
SimpleCov::Formatter::HTMLFormatter,
|
||||
CodeClimate::TestReporter::Formatter
|
||||
]
|
||||
SimpleCov.start
|
||||
|
||||
require "github_changelog_generator"
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
module GitHubChangelogGenerator
|
||||
describe Generator do
|
||||
context "#exclude_issues_by_labels" do
|
||||
let(:label) { double("the-bad-label", name: "BAD") }
|
||||
let(:issue) { double("the-issue-to-be-excluded", labels: [label]) }
|
||||
let(:good_label) { double("a-good-label", name: "GOOD") }
|
||||
let(:good_issue) { double("an-issue-to-be-kept", labels: [good_label]) }
|
||||
let(:issues) { [issue, good_issue] }
|
||||
subject(:generator) { described_class.new(exclude_labels: %w(BAD BOO)) }
|
||||
|
||||
it "removes issues with labels in the exclude_label list" do
|
||||
result = generator.exclude_issues_by_labels(issues)
|
||||
|
||||
expect(result).to include(good_issue)
|
||||
expect(result).not_to include(issue)
|
||||
end
|
||||
|
||||
context "with no option given" do
|
||||
subject(:generator) { described_class.new }
|
||||
it "passes everything through when no option given" do
|
||||
result = generator.exclude_issues_by_labels(issues)
|
||||
|
||||
expect(result).to eq(issues)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,14 +1,19 @@
|
||||
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
|
||||
def tag_mash_with_name(tag)
|
||||
Hashie::Mash.new.tap { |mash_tag| mash_tag.name = tag }
|
||||
end
|
||||
|
||||
def tags_mash_from_strings(tags_strings)
|
||||
tags_strings.map do |tag|
|
||||
tag_mash_with_name(tag)
|
||||
end
|
||||
end
|
||||
|
||||
describe "#filter_between_tags" do
|
||||
context "when between_tags nil" do
|
||||
before do
|
||||
@@ -71,47 +76,31 @@ describe GitHubChangelogGenerator::Generator do
|
||||
describe "#filter_excluded_tags" do
|
||||
subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
|
||||
|
||||
context "with matching string" do
|
||||
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 non-matching string" do
|
||||
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
|
||||
|
||||
context "with matching regex" do
|
||||
context "with regex exclude_tags" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||
end
|
||||
|
||||
context "with non-matching regex" do
|
||||
context "with non-matching regex in exclude_tags" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||
end
|
||||
end
|
||||
|
||||
describe "#filter_excluded_tags_regex" do
|
||||
subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
|
||||
|
||||
context "with matching regex" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||
end
|
||||
|
||||
context "with non-matching regex" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") }
|
||||
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))) }
|
||||
@@ -201,7 +190,7 @@ describe GitHubChangelogGenerator::Generator do
|
||||
@generator.instance_variable_set :@fetcher, mock
|
||||
end
|
||||
subject do
|
||||
of_tag = @generator.get_time_of_tag(tag_mash_with_name("valid_tag"))
|
||||
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) }
|
||||
@@ -210,32 +199,31 @@ describe GitHubChangelogGenerator::Generator do
|
||||
end
|
||||
|
||||
describe "#sort_tags_by_date" do
|
||||
let(:time1) { Time.now }
|
||||
let(:time2) { Time.now }
|
||||
let(:time3) { Time.now }
|
||||
|
||||
time1 = Time.now
|
||||
time2 = Time.now
|
||||
time3 = Time.now
|
||||
before(:all) do
|
||||
@generator = GitHubChangelogGenerator::Generator.new
|
||||
end
|
||||
|
||||
before do
|
||||
@generator.instance_variable_set(:@tag_times_hash, "valid_tag1" => time1,
|
||||
"valid_tag2" => time2,
|
||||
"valid_tag3" => time3)
|
||||
end
|
||||
|
||||
subject do
|
||||
@generator.sort_tags_by_date(tags)
|
||||
end
|
||||
context "sort unsorted tags" do
|
||||
let(:tags) { tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
|
||||
|
||||
tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
|
||||
before do
|
||||
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
||||
end
|
||||
subject do
|
||||
@generator.sort_tags_by_date tags
|
||||
end
|
||||
it { is_expected.to be_a_kind_of(Array) }
|
||||
it { is_expected.to match_array(tags.reverse!) }
|
||||
end
|
||||
context "sort sorted tags" do
|
||||
let(:tags) { tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
|
||||
|
||||
tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
|
||||
before do
|
||||
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
||||
end
|
||||
subject do
|
||||
@generator.sort_tags_by_date tags
|
||||
end
|
||||
it { is_expected.to be_a_kind_of(Array) }
|
||||
it { is_expected.to match_array(tags) }
|
||||
end
|
||||
|
||||
@@ -1,73 +1,41 @@
|
||||
describe GitHubChangelogGenerator::ParserFile do
|
||||
describe ".github_changelog_generator" do
|
||||
let(:options) { {} }
|
||||
|
||||
context "when the well-known default file does not exist" do
|
||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
subject { parser.parse! }
|
||||
context "when no has file" do
|
||||
let(:options) { {} }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
subject { parse.parse! }
|
||||
it { is_expected.to be_nil }
|
||||
end
|
||||
|
||||
context "when file is empty" do
|
||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
|
||||
let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
|
||||
it "does not change the options" do
|
||||
expect { parser.parse! }.to_not change { options }
|
||||
expect { parse.parse! }.to_not change { options }
|
||||
end
|
||||
end
|
||||
|
||||
context "when file is incorrect" do
|
||||
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
|
||||
let(:options_before_change) { options.dup }
|
||||
let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
|
||||
let(:parser) do
|
||||
GitHubChangelogGenerator::ParserFile.new(options, file)
|
||||
end
|
||||
it { expect { parser.parse! }.to raise_error(/line #2/) }
|
||||
end
|
||||
|
||||
context "allows empty lines and comments with semi-colon or pound sign" do
|
||||
let(:file) { StringIO.new("\n \n# Comment on first line\nunreleased_label=staging\n; Comment on third line\nunreleased=false") }
|
||||
let(:parser) do
|
||||
GitHubChangelogGenerator::ParserFile.new(options, file)
|
||||
end
|
||||
it { expect { parser.parse! }.not_to raise_error }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
it { expect { parse.parse! }.to raise_error }
|
||||
end
|
||||
|
||||
context "when override default values" do
|
||||
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
|
||||
let(:options) { {}.merge(default_options) }
|
||||
let(:default_options) { GitHubChangelogGenerator::Parser.get_default_options }
|
||||
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
|
||||
let(:options_before_change) { options.dup }
|
||||
let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
|
||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
|
||||
it "changes the options" do
|
||||
expect { parser.parse! }.to change { options }
|
||||
expect { parse.parse! }.to change { options }
|
||||
.from(options_before_change)
|
||||
.to(options_before_change.merge(unreleased_label: "staging",
|
||||
unreleased: false,
|
||||
header: "=== Changelog ==="))
|
||||
end
|
||||
|
||||
context "turns exclude-labels into an Array", bug: "#327" do
|
||||
let(:file) do
|
||||
StringIO.new(<<EOF
|
||||
exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
|
||||
header_label=# My changelog
|
||||
EOF
|
||||
)
|
||||
end
|
||||
it "reads exclude_labels into an Array" do
|
||||
expect { parser.parse! }.to change { options[:exclude_labels] }
|
||||
.from(default_options[:exclude_labels])
|
||||
.to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
|
||||
end
|
||||
|
||||
it "translates given header_label into the :header option" do
|
||||
expect { parser.parse! }.to change { options[:header] }
|
||||
.from(default_options[:header])
|
||||
.to("# My changelog")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -28,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
|
||||
end
|
||||
describe ".user_project_from_option" do
|
||||
context "when option is invalid" do
|
||||
it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
|
||||
it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
|
||||
end
|
||||
|
||||
context "when option is valid" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||
end
|
||||
context "when option nil" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array([nil, nil]) }
|
||||
end
|
||||
@@ -56,25 +56,5 @@ describe GitHubChangelogGenerator::Parser do
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array([nil, nil]) }
|
||||
end
|
||||
context "when all args is not nil" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", "https://codeclimate.com") }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array([nil, nil]) }
|
||||
end
|
||||
end
|
||||
describe ".fetch_user_and_project" do
|
||||
before :each do
|
||||
ARGV = ["https://github.com/skywinder/github-changelog-generator"]
|
||||
end
|
||||
context do
|
||||
let(:valid_user) { "initialized_user" }
|
||||
let(:options) { { user: valid_user } }
|
||||
let(:options_before_change) { options.dup }
|
||||
it "should leave user unchanged" do
|
||||
expect { GitHubChangelogGenerator::Parser.fetch_user_and_project(options) }.to change { options }
|
||||
.from(options_before_change)
|
||||
.to(options_before_change.merge(project: "github-changelog-generator"))
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user