Compare commits
12 Commits
olleolleol
...
1.11.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
aeba6dc810 | ||
|
|
df6745d737 | ||
|
|
f394a70e5b | ||
|
|
c83355d4e1 | ||
|
|
a5bc2f8562 | ||
|
|
fa757c1878 | ||
|
|
901c5ffba3 | ||
|
|
89ddb6291a | ||
|
|
65594a63c0 | ||
|
|
3a41f22339 | ||
|
|
a139eff84b | ||
|
|
95d4e49171 |
10
.gitignore
vendored
10
.gitignore
vendored
@@ -1,11 +1 @@
|
|||||||
bin/
|
|
||||||
!bin/git-generate-changelog
|
|
||||||
!bin/github_changelog_generator
|
|
||||||
pkg/
|
|
||||||
coverage/
|
coverage/
|
||||||
.bundle
|
|
||||||
spec/*.lock
|
|
||||||
doc
|
|
||||||
.yardoc
|
|
||||||
Gemfile.lock
|
|
||||||
gemfiles/Gemfile.2_4_0.lock
|
|
||||||
|
|||||||
13
.rubocop.yml
13
.rubocop.yml
@@ -1,12 +1,5 @@
|
|||||||
inherit_from: .rubocop_todo.yml
|
inherit_from: .rubocop_todo.yml
|
||||||
|
|
||||||
AllCops:
|
|
||||||
DisplayCopNames: true
|
|
||||||
DisplayStyleGuide: true
|
|
||||||
Exclude:
|
|
||||||
- 'vendor/**/*'
|
|
||||||
- 'gemfiles/**/*'
|
|
||||||
|
|
||||||
Metrics/LineLength:
|
Metrics/LineLength:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
@@ -61,9 +54,3 @@ Style/RegexpLiteral:
|
|||||||
Style/MutableConstant:
|
Style/MutableConstant:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
# "Use idx.positive? instead of idx > 0."
|
|
||||||
Style/NumericPredicate:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
Style/SafeNavigation:
|
|
||||||
Enabled: false
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
2.3.1
|
|
||||||
29
.travis.yml
29
.travis.yml
@@ -1,29 +1,16 @@
|
|||||||
|
sudo: false
|
||||||
language: ruby
|
language: ruby
|
||||||
cache:
|
|
||||||
- bundler
|
|
||||||
before_install:
|
before_install:
|
||||||
- gem update --system
|
- gem update --system
|
||||||
- gem install bundler
|
- gem install bundler
|
||||||
matrix:
|
rvm:
|
||||||
include:
|
- 2.1.0
|
||||||
- rvm: 2.2.2
|
script:
|
||||||
install: true # This skips 'bundle install'
|
- bundle exec rake checks
|
||||||
script: gem build github_changelog_generator && gem install *.gem
|
|
||||||
- rvm: 2.2.2
|
|
||||||
install: true # This skips 'bundle install'
|
|
||||||
script: gem build github_changelog_generator && bundle install
|
|
||||||
gemfile: spec/install-gem-in-bundler.gemfile
|
|
||||||
- rvm: 2.1
|
|
||||||
gemfile: gemfiles/Gemfile.2_1
|
|
||||||
- rvm: 2.3.1
|
|
||||||
gemfile: gemfiles/Gemfile.2_3_1
|
|
||||||
- rvm: 2.4.0-preview2
|
|
||||||
gemfile: gemfiles/Gemfile.2_4_0
|
|
||||||
|
|
||||||
notifications:
|
notifications:
|
||||||
email:
|
email:
|
||||||
recipients:
|
recipients:
|
||||||
- sky4winder+githubchangeloggenerator@gmail.com
|
- sky4winder+githubchangeloggenerator@gmail.com
|
||||||
on_success: never
|
on_success: never
|
||||||
on_failure: change
|
on_failure: change
|
||||||
addons:
|
addons:
|
||||||
|
|||||||
164
CHANGELOG.md
164
CHANGELOG.md
@@ -1,168 +1,12 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
## [1.13.1](https://github.com/skywinder/github-changelog-generator/tree/1.13.1) (2016-07-22)
|
## [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.13.0...1.13.1)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.4...1.10.5)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Don't constrain runtime deps. [\#400](https://github.com/skywinder/github-changelog-generator/pull/400) ([jkeiser](https://github.com/jkeiser))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- `--user` flag should not be ignored [\#397](https://github.com/skywinder/github-changelog-generator/issues/397)
|
|
||||||
- GHE not working with --github-site set to an enterprise site [\#395](https://github.com/skywinder/github-changelog-generator/issues/395)
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- Contributors Section [\#398](https://github.com/skywinder/github-changelog-generator/issues/398)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Ability to implicity set user and project from command line [\#401](https://github.com/skywinder/github-changelog-generator/pull/401) ([skywinder](https://github.com/skywinder))
|
|
||||||
- Show how to use it with Rakefile [\#399](https://github.com/skywinder/github-changelog-generator/pull/399) ([edusantana](https://github.com/edusantana))
|
|
||||||
- Adds documentation on using a GHE endpoint [\#396](https://github.com/skywinder/github-changelog-generator/pull/396) ([cormacmccarthy](https://github.com/cormacmccarthy))
|
|
||||||
- Rake task usage: Added a missing option exclude\_tags\_regex [\#393](https://github.com/skywinder/github-changelog-generator/pull/393) ([perlun](https://github.com/perlun))
|
|
||||||
- Parser: YARD docstrings and a rename, and RegExp named capture groups [\#391](https://github.com/skywinder/github-changelog-generator/pull/391) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
## [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:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
|
- 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)
|
## [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)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.3...1.10.4)
|
||||||
|
|
||||||
@@ -540,6 +384,10 @@
|
|||||||
|
|
||||||
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/github-changelog-generator/issues/34)
|
- 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)
|
## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
|
||||||
|
|
||||||
|
|||||||
19
Gemfile
19
Gemfile
@@ -1,26 +1,11 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
|
|
||||||
gemspec
|
gemspec
|
||||||
|
|
||||||
group :development, :test do
|
|
||||||
gem "rake"
|
|
||||||
gem "bundler"
|
|
||||||
gem "overcommit", ">= 0.31"
|
|
||||||
gem "rubocop", ">= 0.43"
|
|
||||||
end
|
|
||||||
|
|
||||||
group :test do
|
group :test do
|
||||||
gem "vcr"
|
gem "rspec", "~>3.2"
|
||||||
gem "multi_json"
|
gem "rubocop", "~>0.31"
|
||||||
gem "webmock"
|
|
||||||
gem "coveralls", "~>0.8", require: false
|
gem "coveralls", "~>0.8", require: false
|
||||||
gem "simplecov", "~>0.10", require: false
|
gem "simplecov", "~>0.10", require: false
|
||||||
gem "codeclimate-test-reporter", "~>0.4"
|
gem "codeclimate-test-reporter", "~>0.4"
|
||||||
if RUBY_VERSION > "2"
|
|
||||||
gem "json", "~> 2.0", ">= 2.0.2"
|
|
||||||
else
|
|
||||||
gem "json"
|
|
||||||
end
|
|
||||||
gem "rspec", "< 4"
|
|
||||||
end
|
end
|
||||||
|
|||||||
107
Gemfile.lock
Normal file
107
Gemfile.lock
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
PATH
|
||||||
|
remote: .
|
||||||
|
specs:
|
||||||
|
github_changelog_generator (1.10.5)
|
||||||
|
bundler (~> 1.7)
|
||||||
|
colorize (~> 0.7)
|
||||||
|
github_api (~> 0.12)
|
||||||
|
overcommit (~> 0.31)
|
||||||
|
rake (~> 10.0)
|
||||||
|
|
||||||
|
GEM
|
||||||
|
remote: https://rubygems.org/
|
||||||
|
specs:
|
||||||
|
addressable (2.4.0)
|
||||||
|
ast (2.2.0)
|
||||||
|
childprocess (0.5.9)
|
||||||
|
ffi (~> 1.0, >= 1.0.11)
|
||||||
|
codeclimate-test-reporter (0.4.8)
|
||||||
|
simplecov (>= 0.7.1, < 1.0.0)
|
||||||
|
colorize (0.7.7)
|
||||||
|
coveralls (0.8.11)
|
||||||
|
json (~> 1.8)
|
||||||
|
simplecov (~> 0.11.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)
|
||||||
|
multipart-post (>= 1.2, < 3)
|
||||||
|
ffi (1.9.10)
|
||||||
|
github_api (0.13.1)
|
||||||
|
addressable (~> 2.4.0)
|
||||||
|
descendants_tracker (~> 0.0.4)
|
||||||
|
faraday (~> 0.8, < 0.10)
|
||||||
|
hashie (>= 3.4)
|
||||||
|
multi_json (>= 1.7.5, < 2.0)
|
||||||
|
oauth2
|
||||||
|
hashie (3.4.3)
|
||||||
|
iniparse (1.4.2)
|
||||||
|
json (1.8.3)
|
||||||
|
jwt (1.5.1)
|
||||||
|
multi_json (1.11.2)
|
||||||
|
multi_xml (0.5.5)
|
||||||
|
multipart-post (2.0.0)
|
||||||
|
oauth2 (1.1.0)
|
||||||
|
faraday (>= 0.8, < 0.10)
|
||||||
|
jwt (~> 1.0, < 1.5.2)
|
||||||
|
multi_json (~> 1.3)
|
||||||
|
multi_xml (~> 0.5)
|
||||||
|
rack (>= 1.2, < 3)
|
||||||
|
overcommit (0.32.0)
|
||||||
|
childprocess (~> 0.5.8)
|
||||||
|
iniparse (~> 1.4)
|
||||||
|
parser (2.3.0.6)
|
||||||
|
ast (~> 2.2)
|
||||||
|
powerpack (0.1.1)
|
||||||
|
rack (1.6.4)
|
||||||
|
rainbow (2.1.0)
|
||||||
|
rake (10.5.0)
|
||||||
|
rspec (3.4.0)
|
||||||
|
rspec-core (~> 3.4.0)
|
||||||
|
rspec-expectations (~> 3.4.0)
|
||||||
|
rspec-mocks (~> 3.4.0)
|
||||||
|
rspec-core (3.4.3)
|
||||||
|
rspec-support (~> 3.4.0)
|
||||||
|
rspec-expectations (3.4.0)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.4.0)
|
||||||
|
rspec-mocks (3.4.1)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.4.0)
|
||||||
|
rspec-support (3.4.1)
|
||||||
|
rubocop (0.37.2)
|
||||||
|
parser (>= 2.3.0.4, < 3.0)
|
||||||
|
powerpack (~> 0.1)
|
||||||
|
rainbow (>= 1.99.1, < 3.0)
|
||||||
|
ruby-progressbar (~> 1.7)
|
||||||
|
unicode-display_width (~> 0.3)
|
||||||
|
ruby-progressbar (1.7.5)
|
||||||
|
simplecov (0.11.2)
|
||||||
|
docile (~> 1.1.0)
|
||||||
|
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 (0.3.1)
|
||||||
|
|
||||||
|
PLATFORMS
|
||||||
|
ruby
|
||||||
|
|
||||||
|
DEPENDENCIES
|
||||||
|
codeclimate-test-reporter (~> 0.4)
|
||||||
|
coveralls (~> 0.8)
|
||||||
|
github_changelog_generator!
|
||||||
|
rspec (~> 3.2)
|
||||||
|
rubocop (~> 0.31)
|
||||||
|
simplecov (~> 0.10)
|
||||||
|
|
||||||
|
BUNDLED WITH
|
||||||
|
1.11.2
|
||||||
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.
|
|
||||||
|
|
||||||
41
README.md
41
README.md
@@ -4,7 +4,6 @@
|
|||||||
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
[](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
||||||
|
|
||||||
GitHub Changelog Generator 
|
GitHub Changelog Generator 
|
||||||
==================
|
==================
|
||||||
@@ -24,7 +23,7 @@ GitHub Changelog Generator 
|
|||||||
|
|
||||||
### 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 to labels) from :octocat: GitHub Issue Tracker.
|
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
|
||||||
|
|
||||||
Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
|
Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
|
||||||
|
|
||||||
@@ -37,9 +36,7 @@ Because software tools are for people. If you don’t care, why are you contribu
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
gem install github_changelog_generator
|
[sudo] gem install github_changelog_generator
|
||||||
|
|
||||||
See also Troubleshooting.
|
|
||||||
|
|
||||||
## Output example
|
## Output example
|
||||||
|
|
||||||
@@ -80,11 +77,6 @@ See also Troubleshooting.
|
|||||||
- `github_changelog_generator -u github_username -p github_project`
|
- `github_changelog_generator -u github_username -p github_project`
|
||||||
- `github_changelog_generator github_username/github_project`
|
- `github_changelog_generator github_username/github_project`
|
||||||
|
|
||||||
- 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.
|
This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
|
||||||
|
|
||||||
### Params
|
### Params
|
||||||
@@ -109,7 +101,7 @@ Therefore, it's recommended to run this script with authentication by using a **
|
|||||||
|
|
||||||
Here's how:
|
Here's how:
|
||||||
|
|
||||||
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
|
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)
|
||||||
- Either:
|
- Either:
|
||||||
- Run the script with `--token <your-40-digit-token>`; **OR**
|
- Run the script with `--token <your-40-digit-token>`; **OR**
|
||||||
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
|
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
|
||||||
@@ -141,8 +133,6 @@ we've provided a `rake` task library for your changelog generation.
|
|||||||
Just put something like this in your `Rakefile`:
|
Just put something like this in your `Rakefile`:
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
require 'github_changelog_generator/task'
|
|
||||||
|
|
||||||
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
||||||
config.since_tag = '0.1.14'
|
config.since_tag = '0.1.14'
|
||||||
config.future_release = '0.2.0'
|
config.future_release = '0.2.0'
|
||||||
@@ -226,31 +216,6 @@ If you're seeing this warning, please do the following:
|
|||||||
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.
|
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`
|
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`
|
||||||
|
|
||||||
- ***My Ruby version is very old, can I use this?***
|
|
||||||
|
|
||||||
When your Ruby is old, and you don't want to upgrade, and your want to
|
|
||||||
control which libraries you use, you can use Bundler.
|
|
||||||
|
|
||||||
In a Gemfile, perhaps in a non-deployed `:development` group, add this
|
|
||||||
gem:
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
group :development do
|
|
||||||
gem 'github_changelog_generator', require: false
|
|
||||||
end
|
|
||||||
```
|
|
||||||
|
|
||||||
Then you can keep back dependencies like rack, which currently is only
|
|
||||||
compatible with Ruby >= 2.2.2. So, use an older version for your app by
|
|
||||||
adding a line like this to the Gemfile:
|
|
||||||
|
|
||||||
```
|
|
||||||
gem 'rack', '~> 1.6'
|
|
||||||
```
|
|
||||||
|
|
||||||
This way, you can keep on using github_changelog_generator, even if you
|
|
||||||
can't get the latest version of Ruby installed.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
1. Create an issue and describe your idea
|
1. Create an issue and describe your idea
|
||||||
|
|||||||
29
Rakefile
29
Rakefile
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
require "bundler"
|
require "bundler"
|
||||||
require "bundler/gem_tasks"
|
require "bundler/gem_tasks"
|
||||||
require "rubocop/rake_task"
|
require "rubocop/rake_task"
|
||||||
@@ -10,31 +9,15 @@ require "overcommit"
|
|||||||
RuboCop::RakeTask.new
|
RuboCop::RakeTask.new
|
||||||
RSpec::Core::RakeTask.new(:rspec)
|
RSpec::Core::RakeTask.new(:rspec)
|
||||||
|
|
||||||
task :copy_man_page_to_manpath do |_t|
|
task :create_man do |_t|
|
||||||
known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
|
os_prefix = "/usr/local"
|
||||||
manpath = known_manpath_paths.find do |f|
|
man_prefix = Pathname("#{os_prefix}/share/man/man1")
|
||||||
path = Pathname(f)
|
man_pages = "man/git-*"
|
||||||
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|
|
Pathname.glob(man_pages) do |path|
|
||||||
if path.exist? && man_prefix.exist? && man_prefix.writable?
|
FileUtils.cp(path, man_prefix + path.basename)
|
||||||
FileUtils.cp(path, man_prefix + path.basename)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
task checks: [:rubocop, :rspec]
|
task checks: [:rubocop, :rspec]
|
||||||
task default: [:rubocop, :rspec]
|
task default: [:checks, :create_man]
|
||||||
|
|||||||
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
|
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
#! /usr/bin/env ruby
|
#! /usr/bin/env ruby
|
||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require_relative "../lib/github_changelog_generator"
|
require_relative "../lib/github_changelog_generator"
|
||||||
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
#! /usr/bin/env ruby
|
#! /usr/bin/env ruby
|
||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require_relative "../lib/github_changelog_generator"
|
require_relative "../lib/github_changelog_generator"
|
||||||
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
notify:
|
|
||||||
webhooks:
|
|
||||||
# A list of hook hashes, containing the url field
|
|
||||||
# gitter hook
|
|
||||||
- url: https://webhooks.gitter.im/e/2d81eb1ae7695fdc82c4
|
|
||||||
- url: https://webhooks.gitter.im/e/3ec6a35fad7e9991058e
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
|
|
||||||
gem 'rack', '~> 1.6'
|
|
||||||
gem 'activesupport', '~> 4'
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
|
|
||||||
gem 'rack', '>= 2'
|
|
||||||
gem 'activesupport', '>= 4'
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
|
|
||||||
gem 'rack', '>= 2'
|
|
||||||
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
# coding: utf-8
|
# coding: utf-8
|
||||||
# frozen_string_literal: true
|
|
||||||
lib = File.expand_path("../lib", __FILE__)
|
lib = File.expand_path("../lib", __FILE__)
|
||||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||||
require "github_changelog_generator/version"
|
require "github_changelog_generator/version"
|
||||||
@@ -10,23 +10,23 @@ Gem::Specification.new do |spec|
|
|||||||
spec.default_executable = "github_changelog_generator"
|
spec.default_executable = "github_changelog_generator"
|
||||||
|
|
||||||
spec.required_ruby_version = ">= 1.9.3"
|
spec.required_ruby_version = ">= 1.9.3"
|
||||||
spec.authors = ["Petr Korolev", "Olle Jonsson"]
|
spec.authors = ["Petr Korolev"]
|
||||||
spec.email = "sky4winder+github_changelog_generator@gmail.com"
|
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.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.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.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
|
||||||
spec.license = "MIT"
|
spec.license = "MIT"
|
||||||
|
# spec.extensions = ["Rakefile"]
|
||||||
|
|
||||||
spec.files = Dir["{bin,lib,man,spec}/**/*"] + %w(LICENSE Rakefile README.md)
|
spec.files = `git ls-files -z`.split("\x0")
|
||||||
|
|
||||||
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||||
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||||
spec.require_paths = ["lib"]
|
spec.require_paths = ["lib"]
|
||||||
|
|
||||||
spec.add_runtime_dependency "rake", ">= 10.0"
|
spec.add_runtime_dependency "rake", "~> 10.0"
|
||||||
spec.add_runtime_dependency "rainbow", ">= 2.1"
|
spec.add_runtime_dependency "bundler", "~> 1.7"
|
||||||
spec.add_runtime_dependency("octokit", ["~> 4.0"])
|
spec.add_runtime_dependency("github_api", ["~> 0.12"])
|
||||||
spec.add_runtime_dependency("faraday-http-cache")
|
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
||||||
spec.add_runtime_dependency("activesupport")
|
spec.add_runtime_dependency("overcommit", "~>0.31")
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,12 +1,8 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require "octokit"
|
require "github_api"
|
||||||
require "faraday-http-cache"
|
|
||||||
require "logger"
|
|
||||||
require "active_support"
|
|
||||||
require "json"
|
require "json"
|
||||||
require "multi_json"
|
require "colorize"
|
||||||
require "benchmark"
|
require "benchmark"
|
||||||
|
|
||||||
require_relative "github_changelog_generator/helper"
|
require_relative "github_changelog_generator/helper"
|
||||||
@@ -15,8 +11,6 @@ require_relative "github_changelog_generator/parser_file"
|
|||||||
require_relative "github_changelog_generator/generator/generator"
|
require_relative "github_changelog_generator/generator/generator"
|
||||||
require_relative "github_changelog_generator/version"
|
require_relative "github_changelog_generator/version"
|
||||||
require_relative "github_changelog_generator/reader"
|
require_relative "github_changelog_generator/reader"
|
||||||
require_relative "github_changelog_generator/hash"
|
|
||||||
require_relative "github_changelog_generator/array"
|
|
||||||
|
|
||||||
# The main module, where placed all classes (now, at least)
|
# The main module, where placed all classes (now, at least)
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
|
|||||||
@@ -1,14 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
class Array
|
|
||||||
def stringify_keys_deep!
|
|
||||||
new_ar = []
|
|
||||||
each do |value|
|
|
||||||
new_value = value
|
|
||||||
if value.is_a?(Hash) || value.is_a?(Array)
|
|
||||||
new_value = value.stringify_keys_deep!
|
|
||||||
end
|
|
||||||
new_ar << new_value
|
|
||||||
end
|
|
||||||
new_ar
|
|
||||||
end
|
|
||||||
end
|
|
||||||
221
lib/github_changelog_generator/fetcher.rb
Normal file
221
lib/github_changelog_generator/fetcher.rb
Normal file
@@ -0,0 +1,221 @@
|
|||||||
|
module GitHubChangelogGenerator
|
||||||
|
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
|
||||||
|
# (such as filtering, validating, e.t.c)
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# fetcher = GitHubChangelogGenerator::Fetcher.new options
|
||||||
|
|
||||||
|
class Fetcher
|
||||||
|
PER_PAGE_NUMBER = 30
|
||||||
|
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
|
||||||
|
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
|
||||||
|
"missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
|
||||||
|
NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
|
||||||
|
"This script can make only 50 requests to GitHub API per hour without token!"
|
||||||
|
|
||||||
|
def initialize(options = {})
|
||||||
|
@options = options || {}
|
||||||
|
@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 = check_github_response { Github.new @github_options }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Returns GitHub token. First try to use variable, provided by --token option,
|
||||||
|
# otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
|
||||||
|
#
|
||||||
|
# @return [String]
|
||||||
|
def fetch_github_token
|
||||||
|
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
|
||||||
|
|
||||||
|
Helper.log.warn NO_TOKEN_PROVIDED.yellow unless env_var
|
||||||
|
|
||||||
|
env_var
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch all tags from repo
|
||||||
|
# @return [Array] array of tags
|
||||||
|
def get_all_tags
|
||||||
|
print "Fetching tags...\r" if @options[:verbose]
|
||||||
|
|
||||||
|
check_github_response { github_fetch_tags }
|
||||||
|
end
|
||||||
|
|
||||||
|
# This is wrapper with rescue block
|
||||||
|
# @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
|
||||||
|
def check_github_response
|
||||||
|
begin
|
||||||
|
value = yield
|
||||||
|
rescue Github::Error::Unauthorized => e
|
||||||
|
Helper.log.error e.body.red
|
||||||
|
abort "Error: wrong GitHub token"
|
||||||
|
rescue Github::Error::Forbidden => e
|
||||||
|
Helper.log.warn e.body.red
|
||||||
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
value
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fill input array with tags
|
||||||
|
# @return [Array] array of tags in repo
|
||||||
|
def github_fetch_tags
|
||||||
|
tags = []
|
||||||
|
response = @github.repos.tags @options[:user], @options[:project]
|
||||||
|
page_i = 0
|
||||||
|
count_pages = response.count_pages
|
||||||
|
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)
|
||||||
|
end
|
||||||
|
print_empty_line
|
||||||
|
|
||||||
|
if tags.count == 0
|
||||||
|
Helper.log.warn "Warning: Can't find any tags in repo.\
|
||||||
|
Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||||
|
else
|
||||||
|
Helper.log.info "Found #{tags.count} tags"
|
||||||
|
end
|
||||||
|
tags
|
||||||
|
end
|
||||||
|
|
||||||
|
# This method fetch all closed issues and separate them to pull requests and pure issues
|
||||||
|
# (pull request is kind of issue in term of GitHub)
|
||||||
|
# @return [Tuple] with (issues, pull-requests)
|
||||||
|
def fetch_closed_issues_and_pr
|
||||||
|
print "Fetching closed issues...\r" if @options[:verbose]
|
||||||
|
issues = []
|
||||||
|
|
||||||
|
begin
|
||||||
|
response = @github.issues.list user: @options[:user],
|
||||||
|
repo: @options[:project],
|
||||||
|
state: "closed",
|
||||||
|
filter: "all",
|
||||||
|
labels: nil
|
||||||
|
page_i = 0
|
||||||
|
count_pages = response.count_pages
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
|
||||||
|
issues.concat(page)
|
||||||
|
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
||||||
|
end
|
||||||
|
print_empty_line
|
||||||
|
Helper.log.info "Received issues: #{issues.count}"
|
||||||
|
|
||||||
|
rescue
|
||||||
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
|
||||||
|
# separate arrays of issues and pull requests:
|
||||||
|
issues.partition do |x|
|
||||||
|
x[:pull_request].nil?
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch all pull requests. We need them to detect :merged_at parameter
|
||||||
|
# @return [Array] all pull requests
|
||||||
|
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
|
||||||
|
page_i = 0
|
||||||
|
count_pages = response.count_pages
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
|
||||||
|
print_in_same_line(log_string)
|
||||||
|
pull_requests.concat(page)
|
||||||
|
end
|
||||||
|
print_empty_line
|
||||||
|
rescue
|
||||||
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
|
||||||
|
Helper.log.info "Fetching merged dates: #{pull_requests.count}"
|
||||||
|
pull_requests
|
||||||
|
end
|
||||||
|
|
||||||
|
# Print specified line on the same string
|
||||||
|
# @param [String] log_string
|
||||||
|
def print_in_same_line(log_string)
|
||||||
|
print log_string + "\r"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Print long line with spaces on same line to clear prev message
|
||||||
|
def print_empty_line
|
||||||
|
print_in_same_line(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch event for all issues and add them to :events
|
||||||
|
# @param [Array] issues
|
||||||
|
# @return [Void]
|
||||||
|
def fetch_events_async(issues)
|
||||||
|
i = 0
|
||||||
|
max_thread_number = 50
|
||||||
|
threads = []
|
||||||
|
issues.each_slice(max_thread_number) do |issues_slice|
|
||||||
|
issues_slice.each do |issue|
|
||||||
|
threads << Thread.new do
|
||||||
|
begin
|
||||||
|
response = @github.issues.events.list user: @options[:user],
|
||||||
|
repo: @options[:project],
|
||||||
|
issue_number: issue["number"]
|
||||||
|
issue[:events] = []
|
||||||
|
response.each_page do |page|
|
||||||
|
issue[:events].concat(page)
|
||||||
|
end
|
||||||
|
rescue
|
||||||
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
|
||||||
|
i += 1
|
||||||
|
end
|
||||||
|
end
|
||||||
|
threads.each(&:join)
|
||||||
|
threads = []
|
||||||
|
end
|
||||||
|
|
||||||
|
# to clear line from prev print
|
||||||
|
print_empty_line
|
||||||
|
|
||||||
|
Helper.log.info "Fetching events for issues and PR: #{i}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch tag time from repo
|
||||||
|
#
|
||||||
|
# @param [Hash] tag
|
||||||
|
# @return [Time] time of specified tag
|
||||||
|
def fetch_date_of_tag(tag)
|
||||||
|
begin
|
||||||
|
commit_data = @github.git_data.commits.get @options[:user],
|
||||||
|
@options[:project],
|
||||||
|
tag["commit"]["sha"]
|
||||||
|
rescue
|
||||||
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
time_string = commit_data["committer"]["date"]
|
||||||
|
Time.parse(time_string)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch commit for specified event
|
||||||
|
# @return [Hash]
|
||||||
|
def fetch_commit(event)
|
||||||
|
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
# frozen_string_literal: true
|
require_relative "../fetcher"
|
||||||
require_relative "../octo_fetcher"
|
|
||||||
require_relative "generator_generation"
|
require_relative "generator_generation"
|
||||||
require_relative "generator_fetcher"
|
require_relative "generator_fetcher"
|
||||||
require_relative "generator_processor"
|
require_relative "generator_processor"
|
||||||
@@ -11,25 +10,25 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
class Generator
|
class Generator
|
||||||
attr_accessor :options, :filtered_tags, :github, :tag_section_mapping
|
attr_accessor :options, :filtered_tags, :github
|
||||||
|
|
||||||
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues
|
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues
|
||||||
#
|
#
|
||||||
# Example:
|
# Example:
|
||||||
# generator = GitHubChangelogGenerator::Generator.new
|
# generator = GitHubChangelogGenerator::Generator.new
|
||||||
# content = generator.compound_changelog
|
# content = generator.compound_changelog
|
||||||
def initialize(options = {})
|
def initialize(options = nil)
|
||||||
@options = options
|
@options = options || {}
|
||||||
@tag_times_hash = {}
|
@tag_times_hash = {}
|
||||||
@fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
|
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_issues_and_pr
|
def fetch_issues_and_pr
|
||||||
issues, pull_requests = @fetcher.fetch_closed_issues_and_pr
|
issues, pull_requests = @fetcher.fetch_closed_issues_and_pr
|
||||||
|
|
||||||
@pull_requests = options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
|
@pull_requests = @options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
|
||||||
|
|
||||||
@issues = options[:issues] ? get_filtered_issues(issues) : []
|
@issues = @options[:issues] ? get_filtered_issues(issues) : []
|
||||||
|
|
||||||
fetch_events_for_issues_and_pr
|
fetch_events_for_issues_and_pr
|
||||||
detect_actual_closed_dates(@issues + @pull_requests)
|
detect_actual_closed_dates(@issues + @pull_requests)
|
||||||
@@ -61,18 +60,18 @@ module GitHubChangelogGenerator
|
|||||||
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
|
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
|
||||||
|
|
||||||
github_site = options[:github_site] || "https://github.com"
|
github_site = options[:github_site] || "https://github.com"
|
||||||
project_url = "#{github_site}/#{options[:user]}/#{options[:project]}"
|
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
||||||
|
|
||||||
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
|
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
|
||||||
|
|
||||||
if options[:issues]
|
if @options[:issues]
|
||||||
# Generate issues:
|
# Generate issues:
|
||||||
log += issues_to_log(issues, pull_requests)
|
log += issues_to_log(issues, pull_requests)
|
||||||
end
|
end
|
||||||
|
|
||||||
if options[:pulls]
|
if @options[:pulls]
|
||||||
# Generate pull requests:
|
# Generate pull requests:
|
||||||
log += generate_sub_section(pull_requests, options[:merge_prefix])
|
log += generate_sub_section(pull_requests, @options[:merge_prefix])
|
||||||
end
|
end
|
||||||
|
|
||||||
log
|
log
|
||||||
@@ -87,9 +86,9 @@ module GitHubChangelogGenerator
|
|||||||
log = ""
|
log = ""
|
||||||
bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
|
bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
|
||||||
|
|
||||||
log += generate_sub_section(enhancement_a, options[:enhancement_prefix])
|
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
||||||
log += generate_sub_section(bugs_a, options[:bug_prefix])
|
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
||||||
log += generate_sub_section(issues_a, options[:issue_prefix])
|
log += generate_sub_section(issues_a, @options[:issue_prefix])
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -106,32 +105,32 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
issues.each do |dict|
|
issues.each do |dict|
|
||||||
added = false
|
added = false
|
||||||
dict["labels"].each do |label|
|
dict.labels.each do |label|
|
||||||
if options[:bug_labels].include?(label["name"])
|
if @options[:bug_labels].include? label.name
|
||||||
bugs_a.push(dict)
|
bugs_a.push dict
|
||||||
added = true
|
added = true
|
||||||
next
|
next
|
||||||
end
|
end
|
||||||
if options[:enhancement_labels].include?(label["name"])
|
if @options[:enhancement_labels].include? label.name
|
||||||
enhancement_a.push(dict)
|
enhancement_a.push dict
|
||||||
added = true
|
added = true
|
||||||
next
|
next
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
issues_a.push(dict) unless added
|
issues_a.push dict unless added
|
||||||
end
|
end
|
||||||
|
|
||||||
added_pull_requests = []
|
added_pull_requests = []
|
||||||
pull_requests.each do |pr|
|
pull_requests.each do |dict|
|
||||||
pr["labels"].each do |label|
|
dict.labels.each do |label|
|
||||||
if options[:bug_labels].include?(label["name"])
|
if @options[:bug_labels].include? label.name
|
||||||
bugs_a.push(pr)
|
bugs_a.push dict
|
||||||
added_pull_requests.push(pr)
|
added_pull_requests.push dict
|
||||||
next
|
next
|
||||||
end
|
end
|
||||||
if options[:enhancement_labels].include?(label["name"])
|
if @options[:enhancement_labels].include? label.name
|
||||||
enhancement_a.push(pr)
|
enhancement_a.push dict
|
||||||
added_pull_requests.push(pr)
|
added_pull_requests.push dict
|
||||||
next
|
next
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,12 +1,9 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Generator
|
class Generator
|
||||||
MAX_THREAD_NUMBER = 1
|
|
||||||
|
|
||||||
# Fetch event for issues and pull requests
|
# Fetch event for issues and pull requests
|
||||||
# @return [Array] array of fetched issues
|
# @return [Array] array of fetched issues
|
||||||
def fetch_events_for_issues_and_pr
|
def fetch_events_for_issues_and_pr
|
||||||
if options[:verbose]
|
if @options[:verbose]
|
||||||
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
|
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -15,47 +12,48 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
# Async fetching of all tags dates
|
# Async fetching of all tags dates
|
||||||
def fetch_tags_dates(tags)
|
def fetch_tags_dates
|
||||||
print "Fetching tag dates...\r" if options[:verbose]
|
print "Fetching tag dates...\r" if @options[:verbose]
|
||||||
# Async fetching tags:
|
# Async fetching tags:
|
||||||
threads = []
|
threads = []
|
||||||
i = 0
|
i = 0
|
||||||
all = tags.count
|
all = @filtered_tags.count
|
||||||
tags.each do |tag|
|
@filtered_tags.each do |tag|
|
||||||
print " \r"
|
print " \r"
|
||||||
threads << Thread.new do
|
threads << Thread.new do
|
||||||
get_time_of_tag(tag)
|
get_time_of_tag(tag)
|
||||||
print "Fetching tags dates: #{i + 1}/#{all}\r" if options[:verbose]
|
print "Fetching tags dates: #{i + 1}/#{all}\r" if @options[:verbose]
|
||||||
i += 1
|
i += 1
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
threads.each(&:join)
|
threads.each(&:join)
|
||||||
puts "Fetching tags dates: #{i}" if options[:verbose]
|
puts "Fetching tags dates: #{i}" if @options[:verbose]
|
||||||
end
|
end
|
||||||
|
|
||||||
# Find correct closed dates, if issues was closed by commits
|
# Find correct closed dates, if issues was closed by commits
|
||||||
def detect_actual_closed_dates(issues)
|
def detect_actual_closed_dates(issues)
|
||||||
print "Fetching closed dates for issues...\r" if options[:verbose]
|
print "Fetching closed dates for issues...\r" if @options[:verbose]
|
||||||
|
|
||||||
issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
|
max_thread_number = 50
|
||||||
|
issues.each_slice(max_thread_number) do |issues_slice|
|
||||||
threads = []
|
threads = []
|
||||||
issues_slice.each do |issue|
|
issues_slice.each do |issue|
|
||||||
threads << Thread.new { find_closed_date_by_commit(issue) }
|
threads << Thread.new { find_closed_date_by_commit(issue) }
|
||||||
end
|
end
|
||||||
threads.each(&:join)
|
threads.each(&:join)
|
||||||
end
|
end
|
||||||
puts "Fetching closed dates for issues: Done!" if options[:verbose]
|
puts "Fetching closed dates for issues: Done!" if @options[:verbose]
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
|
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
|
||||||
# @param [Hash] issue
|
# @param [Hash] issue
|
||||||
def find_closed_date_by_commit(issue)
|
def find_closed_date_by_commit(issue)
|
||||||
unless issue["events"].nil?
|
unless issue[:events].nil?
|
||||||
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
||||||
compare_string = issue["merged_at"].nil? ? "closed" : "merged"
|
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
|
||||||
# reverse! - to find latest closed event. (event goes in date order)
|
# reverse! - to find latest closed event. (event goes in date order)
|
||||||
issue["events"].reverse!.each do |event|
|
issue[:events].reverse!.each do |event|
|
||||||
if event["event"].eql? compare_string
|
if event[:event].eql? compare_string
|
||||||
set_date_from_event(event, issue)
|
set_date_from_event(event, issue)
|
||||||
break
|
break
|
||||||
end
|
end
|
||||||
@@ -69,17 +67,15 @@ module GitHubChangelogGenerator
|
|||||||
# @param [Hash] event
|
# @param [Hash] event
|
||||||
# @param [Hash] issue
|
# @param [Hash] issue
|
||||||
def set_date_from_event(event, issue)
|
def set_date_from_event(event, issue)
|
||||||
if event["commit_id"].nil?
|
if event[:commit_id].nil?
|
||||||
issue["actual_date"] = issue["closed_at"]
|
issue[:actual_date] = issue[:closed_at]
|
||||||
else
|
else
|
||||||
begin
|
begin
|
||||||
commit = @fetcher.fetch_commit(event)
|
commit = @fetcher.fetch_commit(event)
|
||||||
issue["actual_date"] = commit["commit"]["author"]["date"]
|
issue[:actual_date] = commit[:author][:date]
|
||||||
|
|
||||||
# issue['actual_date'] = commit['author']['date']
|
|
||||||
rescue
|
rescue
|
||||||
puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
|
puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
|
||||||
issue["actual_date"] = issue["closed_at"]
|
issue[:actual_date] = issue[:closed_at]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Generator
|
class Generator
|
||||||
# Main function to start change log generation
|
# Main function to start change log generation
|
||||||
@@ -6,24 +5,48 @@ module GitHubChangelogGenerator
|
|||||||
# @return [String] Generated change log file
|
# @return [String] Generated change log file
|
||||||
def compound_changelog
|
def compound_changelog
|
||||||
fetch_and_filter_tags
|
fetch_and_filter_tags
|
||||||
|
sort_tags_by_date(@filtered_tags)
|
||||||
fetch_issues_and_pr
|
fetch_issues_and_pr
|
||||||
|
|
||||||
log = ""
|
log = ""
|
||||||
log += options[:frontmatter] if options[:frontmatter]
|
log += @options[:frontmatter] if @options[:frontmatter]
|
||||||
log += "#{options[:header]}\n\n"
|
log += "#{@options[:header]}\n\n"
|
||||||
|
|
||||||
log += if options[:unreleased_only]
|
log += if @options[:unreleased_only]
|
||||||
generate_log_between_tags(filtered_tags[0], nil)
|
generate_log_between_tags(filtered_tags[0], nil)
|
||||||
else
|
else
|
||||||
generate_log_for_all_tags
|
generate_log_for_all_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
log += File.read(options[:base]) if File.file?(options[:base])
|
log += File.read(@options[:base]) if File.file?(@options[:base])
|
||||||
|
|
||||||
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||||
@log = log
|
@log = log
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# @return [String] temp method should be removed soon
|
||||||
|
def generate_for_2_tags(log)
|
||||||
|
tag1 = @options[:tag1]
|
||||||
|
tag2 = @options[:tag2]
|
||||||
|
tags_strings = []
|
||||||
|
filtered_tags.each { |x| tags_strings.push(x["name"]) }
|
||||||
|
|
||||||
|
if tags_strings.include?(tag1)
|
||||||
|
if tags_strings.include?(tag2)
|
||||||
|
to_a = tags_strings.map.with_index.to_a
|
||||||
|
hash = Hash[to_a]
|
||||||
|
index1 = hash[tag1]
|
||||||
|
index2 = hash[tag2]
|
||||||
|
log += generate_log_between_tags(all_tags[index1], all_tags[index2])
|
||||||
|
else
|
||||||
|
raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
|
||||||
|
end
|
||||||
|
else
|
||||||
|
raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
|
||||||
|
end
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
# @param [Array] issues List of issues on sub-section
|
# @param [Array] issues List of issues on sub-section
|
||||||
# @param [String] prefix Nae of sub-section
|
# @param [String] prefix Nae of sub-section
|
||||||
# @return [String] Generate ready-to-go sub-section
|
# @return [String] Generate ready-to-go sub-section
|
||||||
@@ -53,21 +76,21 @@ module GitHubChangelogGenerator
|
|||||||
log = ""
|
log = ""
|
||||||
|
|
||||||
# Generate date string:
|
# Generate date string:
|
||||||
time_string = newer_tag_time.strftime(options[:date_format])
|
time_string = newer_tag_time.strftime @options[:date_format]
|
||||||
|
|
||||||
# Generate tag name and link
|
# Generate tag name and link
|
||||||
release_url = if options[:release_url]
|
release_url = if @options[:release_url]
|
||||||
format(options[:release_url], newer_tag_link)
|
format(@options[:release_url], newer_tag_link)
|
||||||
else
|
else
|
||||||
"#{project_url}/tree/#{newer_tag_link}"
|
"#{project_url}/tree/#{newer_tag_link}"
|
||||||
end
|
end
|
||||||
log += if newer_tag_name.equal?(options[:unreleased_label])
|
log += if newer_tag_name.equal? @options[:unreleased_label]
|
||||||
"## [#{newer_tag_name}](#{release_url})\n\n"
|
"## [#{newer_tag_name}](#{release_url})\n\n"
|
||||||
else
|
else
|
||||||
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
|
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
|
||||||
end
|
end
|
||||||
|
|
||||||
if options[:compare_link] && older_tag_link
|
if @options[:compare_link] && older_tag_link
|
||||||
# Generate compare link
|
# Generate compare link
|
||||||
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
|
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
|
||||||
end
|
end
|
||||||
@@ -95,12 +118,12 @@ module GitHubChangelogGenerator
|
|||||||
#
|
#
|
||||||
# @return [Array] filtered issues and pull requests
|
# @return [Array] filtered issues and pull requests
|
||||||
def filter_issues_for_tags(newer_tag, older_tag)
|
def filter_issues_for_tags(newer_tag, older_tag)
|
||||||
filtered_pull_requests = delete_by_time(@pull_requests, "actual_date", older_tag, newer_tag)
|
filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
|
||||||
filtered_issues = delete_by_time(@issues, "actual_date", older_tag, newer_tag)
|
filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
|
||||||
|
|
||||||
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
|
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
|
||||||
|
|
||||||
if options[:filter_issues_by_milestone]
|
if @options[:filter_issues_by_milestone]
|
||||||
# delete excess irrelevant issues (according milestones). Issue #22.
|
# delete excess irrelevant issues (according milestones). Issue #22.
|
||||||
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
|
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
|
||||||
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
|
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
|
||||||
@@ -111,13 +134,15 @@ module GitHubChangelogGenerator
|
|||||||
# The full cycle of generation for whole project
|
# The full cycle of generation for whole project
|
||||||
# @return [String] The complete change log
|
# @return [String] The complete change log
|
||||||
def generate_log_for_all_tags
|
def generate_log_for_all_tags
|
||||||
puts "Generating log..." if options[:verbose]
|
puts "Generating log..." if @options[:verbose]
|
||||||
|
|
||||||
log = generate_unreleased_section
|
log = generate_unreleased_section
|
||||||
|
|
||||||
@tag_section_mapping.each_pair do |_tag_section, left_right_tags|
|
(1...filtered_tags.size).each do |index|
|
||||||
older_tag, newer_tag = left_right_tags
|
log += generate_log_between_tags(filtered_tags[index], filtered_tags[index - 1])
|
||||||
log += generate_log_between_tags(older_tag, newer_tag)
|
end
|
||||||
|
if @filtered_tags.count != 0
|
||||||
|
log += generate_log_between_tags(nil, filtered_tags.last)
|
||||||
end
|
end
|
||||||
|
|
||||||
log
|
log
|
||||||
@@ -125,7 +150,7 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
def generate_unreleased_section
|
def generate_unreleased_section
|
||||||
log = ""
|
log = ""
|
||||||
if options[:unreleased]
|
if @options[:unreleased]
|
||||||
unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
|
unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
|
||||||
log += unreleased_log if unreleased_log
|
log += unreleased_log if unreleased_log
|
||||||
end
|
end
|
||||||
@@ -135,30 +160,25 @@ module GitHubChangelogGenerator
|
|||||||
# Parse issue and generate single line formatted issue line.
|
# Parse issue and generate single line formatted issue line.
|
||||||
#
|
#
|
||||||
# Example output:
|
# 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
|
# @param [Hash] issue Fetched issue from GitHub
|
||||||
# @return [String] Markdown-formatted single issue
|
# @return [String] Markdown-formatted single issue
|
||||||
def get_string_for_issue(issue)
|
def get_string_for_issue(issue)
|
||||||
encapsulated_title = encapsulate_string issue["title"]
|
encapsulated_title = encapsulate_string issue[:title]
|
||||||
|
|
||||||
title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
|
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
|
||||||
issue_line_with_user(title_with_number, issue)
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
unless issue.pull_request.nil?
|
||||||
|
if @options[:author]
|
||||||
def issue_line_with_user(line, issue)
|
title_with_number += if issue.user.nil?
|
||||||
return line if !options[:author] || issue.pull_request.nil?
|
" ({Null user})"
|
||||||
|
else
|
||||||
user = issue["user"]
|
" ([#{issue.user.login}](#{issue.user.html_url}))"
|
||||||
return "#{line} ({Null user})" unless user
|
end
|
||||||
|
end
|
||||||
if options[:usernames_as_github_logins]
|
|
||||||
"#{line} (@#{user['login']})"
|
|
||||||
else
|
|
||||||
"#{line} ([#{user['login']}](#{user['html_url']}))"
|
|
||||||
end
|
end
|
||||||
|
title_with_number
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Generator
|
class Generator
|
||||||
# delete all labels with labels from options[:exclude_labels] array
|
# delete all labels with labels from @options[:exclude_labels] array
|
||||||
# @param [Array] issues
|
# @param [Array] issues
|
||||||
# @return [Array] filtered array
|
# @return [Array] filtered array
|
||||||
def exclude_issues_by_labels(issues)
|
def exclude_issues_by_labels(issues)
|
||||||
return issues if !options[:exclude_labels] || options[:exclude_labels].empty?
|
unless @options[:exclude_labels].nil?
|
||||||
|
issues = issues.select do |issue|
|
||||||
issues.reject do |issue|
|
var = issue.labels.map(&:name) & @options[:exclude_labels]
|
||||||
labels = issue["labels"].map { |l| l["name"] }
|
!var.any?
|
||||||
(labels & options[:exclude_labels]).any?
|
end
|
||||||
end
|
end
|
||||||
|
issues
|
||||||
end
|
end
|
||||||
|
|
||||||
# @return [Array] filtered issues accourding milestone
|
# @return [Array] filtered issues accourding milestone
|
||||||
@@ -32,18 +32,18 @@ module GitHubChangelogGenerator
|
|||||||
# @return [Array] issues with milestone #tag_name
|
# @return [Array] issues with milestone #tag_name
|
||||||
def find_issues_to_add(all_issues, tag_name)
|
def find_issues_to_add(all_issues, tag_name)
|
||||||
all_issues.select do |issue|
|
all_issues.select do |issue|
|
||||||
if issue["milestone"].nil?
|
if issue.milestone.nil?
|
||||||
false
|
false
|
||||||
else
|
else
|
||||||
# check, that this milestone in tag list:
|
# check, that this milestone in tag list:
|
||||||
milestone_is_tag = @filtered_tags.find do |tag|
|
milestone_is_tag = @filtered_tags.find do |tag|
|
||||||
tag["name"] == issue["milestone"]["title"]
|
tag.name == issue.milestone.title
|
||||||
end
|
end
|
||||||
|
|
||||||
if milestone_is_tag.nil?
|
if milestone_is_tag.nil?
|
||||||
false
|
false
|
||||||
else
|
else
|
||||||
issue["milestone"]["title"] == tag_name
|
issue.milestone.title == tag_name
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -53,11 +53,11 @@ module GitHubChangelogGenerator
|
|||||||
def remove_issues_in_milestones(filtered_issues)
|
def remove_issues_in_milestones(filtered_issues)
|
||||||
filtered_issues.select! do |issue|
|
filtered_issues.select! do |issue|
|
||||||
# leave issues without milestones
|
# leave issues without milestones
|
||||||
if issue["milestone"].nil?
|
if issue.milestone.nil?
|
||||||
true
|
true
|
||||||
else
|
else
|
||||||
# check, that this milestone in tag list:
|
# check, that this milestone in tag list:
|
||||||
@filtered_tags.find { |tag| tag["name"] == issue["milestone"]["title"] }.nil?
|
@filtered_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -68,7 +68,7 @@ module GitHubChangelogGenerator
|
|||||||
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
||||||
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
||||||
# @return [Array] filtered issues
|
# @return [Array] filtered issues
|
||||||
def delete_by_time(issues, hash_key = "actual_date", older_tag = nil, newer_tag = nil)
|
def delete_by_time(issues, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
|
||||||
# in case if not tags specified - return unchanged array
|
# in case if not tags specified - return unchanged array
|
||||||
return issues if older_tag.nil? && newer_tag.nil?
|
return issues if older_tag.nil? && newer_tag.nil?
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
issues.select do |issue|
|
issues.select do |issue|
|
||||||
if issue[hash_key]
|
if issue[hash_key]
|
||||||
time = Time.parse(issue[hash_key].to_s).utc
|
time = Time.parse(issue[hash_key]).utc
|
||||||
|
|
||||||
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
||||||
|
|
||||||
@@ -121,9 +121,9 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
# @return [Array] issues without labels or empty array if add_issues_wo_labels is false
|
# @return [Array] issues without labels or empty array if add_issues_wo_labels is false
|
||||||
def filter_wo_labels(issues)
|
def filter_wo_labels(issues)
|
||||||
if options[:add_issues_wo_labels]
|
if @options[:add_issues_wo_labels]
|
||||||
issues_wo_labels = issues.select do |issue|
|
issues_wo_labels = issues.select do |issue|
|
||||||
!issue["labels"].map { |l| l["name"] }.any?
|
!issue.labels.map(&:name).any?
|
||||||
end
|
end
|
||||||
return issues_wo_labels
|
return issues_wo_labels
|
||||||
end
|
end
|
||||||
@@ -131,14 +131,11 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
def filter_by_include_labels(issues)
|
def filter_by_include_labels(issues)
|
||||||
if options[:include_labels].nil?
|
filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
|
||||||
issues
|
labels = issue.labels.map(&:name) & @options[:include_labels]
|
||||||
else
|
labels.any?
|
||||||
issues.select do |issue|
|
|
||||||
labels = issue["labels"].map { |l| l["name"] } & options[:include_labels]
|
|
||||||
labels.any?
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
filtered_issues
|
||||||
end
|
end
|
||||||
|
|
||||||
# General filtered function
|
# General filtered function
|
||||||
@@ -154,18 +151,18 @@ module GitHubChangelogGenerator
|
|||||||
# @return [Array] Filtered issues
|
# @return [Array] Filtered issues
|
||||||
def get_filtered_issues(issues)
|
def get_filtered_issues(issues)
|
||||||
issues = filter_array_by_labels(issues)
|
issues = filter_array_by_labels(issues)
|
||||||
puts "Filtered issues: #{issues.count}" if options[:verbose]
|
puts "Filtered issues: #{issues.count}" if @options[:verbose]
|
||||||
issues
|
issues
|
||||||
end
|
end
|
||||||
|
|
||||||
# This method fetches missing params for PR and filter them by specified options
|
# This method fetches missing params for PR and filter them by specified options
|
||||||
# It include add all PR's with labels from options[:include_labels] array
|
# It include add all PR's with labels from @options[:include_labels] array
|
||||||
# And exclude all from :exclude_labels array.
|
# And exclude all from :exclude_labels array.
|
||||||
# @return [Array] filtered PR's
|
# @return [Array] filtered PR's
|
||||||
def get_filtered_pull_requests(pull_requests)
|
def get_filtered_pull_requests(pull_requests)
|
||||||
pull_requests = filter_array_by_labels(pull_requests)
|
pull_requests = filter_array_by_labels(pull_requests)
|
||||||
pull_requests = filter_merged_pull_requests(pull_requests)
|
pull_requests = filter_merged_pull_requests(pull_requests)
|
||||||
puts "Filtered pull requests: #{pull_requests.count}" if options[:verbose]
|
puts "Filtered pull requests: #{pull_requests.count}" if @options[:verbose]
|
||||||
pull_requests
|
pull_requests
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -174,21 +171,21 @@ module GitHubChangelogGenerator
|
|||||||
# :merged_at - is a date, when issue PR was merged.
|
# :merged_at - is a date, when issue PR was merged.
|
||||||
# More correct to use merged date, rather than closed date.
|
# More correct to use merged date, rather than closed date.
|
||||||
def filter_merged_pull_requests(pull_requests)
|
def filter_merged_pull_requests(pull_requests)
|
||||||
print "Fetching merged dates...\r" if options[:verbose]
|
print "Fetching merged dates...\r" if @options[:verbose]
|
||||||
closed_pull_requests = @fetcher.fetch_closed_pull_requests
|
closed_pull_requests = @fetcher.fetch_closed_pull_requests
|
||||||
|
|
||||||
pull_requests.each do |pr|
|
pull_requests.each do |pr|
|
||||||
fetched_pr = closed_pull_requests.find do |fpr|
|
fetched_pr = closed_pull_requests.find do |fpr|
|
||||||
fpr["number"] == pr["number"]
|
fpr.number == pr.number
|
||||||
end
|
end
|
||||||
if fetched_pr
|
if fetched_pr
|
||||||
pr["merged_at"] = fetched_pr["merged_at"]
|
pr[:merged_at] = fetched_pr[:merged_at]
|
||||||
closed_pull_requests.delete(fetched_pr)
|
closed_pull_requests.delete(fetched_pr)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
pull_requests.select! do |pr|
|
pull_requests.select! do |pr|
|
||||||
!pr["merged_at"].nil?
|
!pr[:merged_at].nil?
|
||||||
end
|
end
|
||||||
|
|
||||||
pull_requests
|
pull_requests
|
||||||
|
|||||||
@@ -1,61 +1,34 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Generator
|
class Generator
|
||||||
# fetch, filter tags, fetch dates and sort them in time order
|
# fetch, filter tags, fetch dates and sort them in time order
|
||||||
def fetch_and_filter_tags
|
def fetch_and_filter_tags
|
||||||
detect_since_tag
|
@filtered_tags = get_filtered_tags(@fetcher.get_all_tags)
|
||||||
detect_due_tag
|
fetch_tags_dates
|
||||||
|
|
||||||
all_tags = @fetcher.get_all_tags
|
|
||||||
included_tags = filter_excluded_tags(all_tags)
|
|
||||||
|
|
||||||
fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
|
|
||||||
sorted_tags = sort_tags_by_date(included_tags)
|
|
||||||
@filtered_tags = get_filtered_tags(included_tags)
|
|
||||||
|
|
||||||
@tag_section_mapping = build_tag_section_mapping(@filtered_tags, sorted_tags)
|
|
||||||
|
|
||||||
@filtered_tags
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# @param [Array] filtered_tags are the tags that need a subsection output
|
# Sort all tags by date
|
||||||
# @param [Array] all_tags is the list of all tags ordered from newest -> oldest
|
|
||||||
# @return [Hash] key is the tag to output, value is an array of [Left Tag, Right Tag]
|
|
||||||
# PRs to include in this section will be >= [Left Tag Date] and <= [Right Tag Date]
|
|
||||||
def build_tag_section_mapping(filtered_tags, all_tags)
|
|
||||||
tag_mapping = {}
|
|
||||||
filtered_tags.each do |tag|
|
|
||||||
older_tag_idx = all_tags.index(tag) + 1
|
|
||||||
older_tag = all_tags[older_tag_idx]
|
|
||||||
tag_mapping[tag] = [older_tag, tag]
|
|
||||||
end
|
|
||||||
tag_mapping
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sort all tags by date, newest to oldest
|
|
||||||
def sort_tags_by_date(tags)
|
def sort_tags_by_date(tags)
|
||||||
puts "Sorting tags..." if options[:verbose]
|
puts "Sorting tags..." if @options[:verbose]
|
||||||
tags.sort_by! do |x|
|
tags.sort_by! do |x|
|
||||||
get_time_of_tag(x)
|
get_time_of_tag(x)
|
||||||
end.reverse!
|
end.reverse!
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns date for given GitHub Tag hash
|
# Try to find tag date in local hash.
|
||||||
#
|
# Otherwise fFetch tag time and put it to local hash file.
|
||||||
# Memoize the date by tag name.
|
# @param [Hash] tag_name name of the tag
|
||||||
#
|
|
||||||
# @param [Hash] tag_name
|
|
||||||
#
|
|
||||||
# @return [Time] time of specified tag
|
# @return [Time] time of specified tag
|
||||||
def get_time_of_tag(tag_name)
|
def get_time_of_tag(tag_name)
|
||||||
raise ChangelogGeneratorError, "tag_name is nil" if tag_name.nil?
|
raise ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
|
||||||
|
|
||||||
name_of_tag = tag_name.fetch("name")
|
name_of_tag = tag_name["name"]
|
||||||
time_for_tag_name = @tag_times_hash[name_of_tag]
|
time_for_name = @tag_times_hash[name_of_tag]
|
||||||
return time_for_tag_name if time_for_tag_name
|
if !time_for_name.nil?
|
||||||
|
time_for_name
|
||||||
@fetcher.fetch_date_of_tag(tag_name).tap do |time_string|
|
else
|
||||||
|
time_string = @fetcher.fetch_date_of_tag tag_name
|
||||||
@tag_times_hash[name_of_tag] = time_string
|
@tag_times_hash[name_of_tag] = time_string
|
||||||
|
time_string
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -68,12 +41,12 @@ module GitHubChangelogGenerator
|
|||||||
newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
|
newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
|
||||||
|
|
||||||
# if it's future release tag - set this value
|
# if it's future release tag - set this value
|
||||||
if newer_tag.nil? && options[:future_release]
|
if newer_tag.nil? && @options[:future_release]
|
||||||
newer_tag_name = options[:future_release]
|
newer_tag_name = @options[:future_release]
|
||||||
newer_tag_link = options[:future_release]
|
newer_tag_link = @options[:future_release]
|
||||||
else
|
else
|
||||||
# put unreleased label if there is no name for the tag
|
# put unreleased label if there is no name for the tag
|
||||||
newer_tag_name = newer_tag.nil? ? options[:unreleased_label] : newer_tag["name"]
|
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
|
||||||
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
|
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
|
||||||
end
|
end
|
||||||
[newer_tag_link, newer_tag_name, newer_tag_time]
|
[newer_tag_link, newer_tag_name, newer_tag_time]
|
||||||
@@ -81,18 +54,13 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
|
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
|
||||||
def detect_since_tag
|
def detect_since_tag
|
||||||
@since_tag ||= options.fetch(:since_tag) { version_of_first_item }
|
@since_tag ||= @options[:since_tag]
|
||||||
end
|
if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
|
||||||
|
reader = GitHubChangelogGenerator::Reader.new
|
||||||
def detect_due_tag
|
content = reader.read(@options[:base])
|
||||||
@due_tag ||= options.fetch(:due_tag, nil)
|
@since_tag = content[0]["version"] if content.count && content
|
||||||
end
|
end
|
||||||
|
@since_tag
|
||||||
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?
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
||||||
@@ -100,8 +68,8 @@ module GitHubChangelogGenerator
|
|||||||
# @return [Array]
|
# @return [Array]
|
||||||
def get_filtered_tags(all_tags)
|
def get_filtered_tags(all_tags)
|
||||||
filtered_tags = filter_since_tag(all_tags)
|
filtered_tags = filter_since_tag(all_tags)
|
||||||
filtered_tags = filter_due_tag(filtered_tags)
|
filtered_tags = filter_between_tags(filtered_tags)
|
||||||
filter_between_tags(filtered_tags)
|
filter_excluded_tags(filtered_tags)
|
||||||
end
|
end
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
# @param [Array] all_tags all tags
|
||||||
@@ -110,8 +78,8 @@ module GitHubChangelogGenerator
|
|||||||
filtered_tags = all_tags
|
filtered_tags = all_tags
|
||||||
tag = detect_since_tag
|
tag = detect_since_tag
|
||||||
if tag
|
if tag
|
||||||
if all_tags.map { |t| t["name"] }.include? tag
|
if all_tags.map(&:name).include? tag
|
||||||
idx = all_tags.index { |t| t["name"] == tag }
|
idx = all_tags.index { |t| t.name == tag }
|
||||||
filtered_tags = if idx > 0
|
filtered_tags = if idx > 0
|
||||||
all_tags[0..idx - 1]
|
all_tags[0..idx - 1]
|
||||||
else
|
else
|
||||||
@@ -128,12 +96,13 @@ module GitHubChangelogGenerator
|
|||||||
# @return [Array] filtered tags according :due_tag option
|
# @return [Array] filtered tags according :due_tag option
|
||||||
def filter_due_tag(all_tags)
|
def filter_due_tag(all_tags)
|
||||||
filtered_tags = all_tags
|
filtered_tags = all_tags
|
||||||
tag = detect_due_tag
|
tag = @options[:due_tag]
|
||||||
if tag
|
if tag
|
||||||
if all_tags.any? && all_tags.map { |t| t["name"] }.include?(tag)
|
if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
|
||||||
idx = all_tags.index { |t| t["name"] == tag }
|
idx = all_tags.index { |t| t.name == tag }
|
||||||
filtered_tags = if idx > 0
|
last_index = all_tags.count - 1
|
||||||
all_tags[(idx + 1)..-1]
|
filtered_tags = if idx > 0 && idx < last_index
|
||||||
|
all_tags[idx + 1..last_index]
|
||||||
else
|
else
|
||||||
[]
|
[]
|
||||||
end
|
end
|
||||||
@@ -148,67 +117,57 @@ module GitHubChangelogGenerator
|
|||||||
# @return [Array] filtered tags according :between_tags option
|
# @return [Array] filtered tags according :between_tags option
|
||||||
def filter_between_tags(all_tags)
|
def filter_between_tags(all_tags)
|
||||||
filtered_tags = all_tags
|
filtered_tags = all_tags
|
||||||
tag_names = filtered_tags.map { |ft| ft["name"] }
|
if @options[:between_tags]
|
||||||
|
@options[:between_tags].each do |tag|
|
||||||
if options[:between_tags]
|
unless all_tags.map(&:name).include? tag
|
||||||
options[:between_tags].each do |tag|
|
|
||||||
unless tag_names.include?(tag)
|
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
filtered_tags = all_tags.select { |tag| options[:between_tags].include?(tag["name"]) }
|
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag.name }
|
||||||
end
|
end
|
||||||
filtered_tags
|
filtered_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
# @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)
|
def filter_excluded_tags(all_tags)
|
||||||
if options[:exclude_tags]
|
return all_tags unless @options[:exclude_tags]
|
||||||
apply_exclude_tags(all_tags)
|
|
||||||
elsif options[:exclude_tags_regex]
|
apply_exclude_tags(all_tags)
|
||||||
apply_exclude_tags_regex(all_tags)
|
|
||||||
else
|
|
||||||
all_tags
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
def apply_exclude_tags(all_tags)
|
def apply_exclude_tags(all_tags)
|
||||||
if options[:exclude_tags].is_a?(Regexp)
|
if @options[:exclude_tags].is_a?(Regexp)
|
||||||
filter_tags_with_regex(all_tags, options[:exclude_tags])
|
filter_tags_with_regex(all_tags)
|
||||||
else
|
else
|
||||||
filter_exact_tags(all_tags)
|
filter_exact_tags(all_tags)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def apply_exclude_tags_regex(all_tags)
|
def filter_tags_with_regex(all_tags)
|
||||||
filter_tags_with_regex(all_tags, Regexp.new(options[:exclude_tags_regex]))
|
|
||||||
end
|
|
||||||
|
|
||||||
def filter_tags_with_regex(all_tags, regex)
|
|
||||||
warn_if_nonmatching_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
|
end
|
||||||
|
|
||||||
def filter_exact_tags(all_tags)
|
def filter_exact_tags(all_tags)
|
||||||
options[:exclude_tags].each do |tag|
|
@options[:exclude_tags].each do |tag|
|
||||||
warn_if_tag_not_found(all_tags, tag)
|
warn_if_tag_not_found(all_tags, tag)
|
||||||
end
|
end
|
||||||
all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) }
|
all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
|
||||||
end
|
end
|
||||||
|
|
||||||
def warn_if_nonmatching_regex(all_tags)
|
def warn_if_nonmatching_regex(all_tags)
|
||||||
unless all_tags.map { |t| t["name"] }.any? { |t| options[:exclude_tags] =~ t }
|
unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
|
||||||
Helper.log.warn "Warning: unable to reject any tag, using regex "\
|
Helper.log.warn "Warning: unable to reject any tag, using regex "\
|
||||||
"#{options[:exclude_tags].inspect} in --exclude-tags "\
|
"#{@options[:exclude_tags].inspect} in --exclude-tags "\
|
||||||
"option."
|
"option."
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def warn_if_tag_not_found(all_tags, tag)
|
def warn_if_tag_not_found(all_tags, tag)
|
||||||
unless all_tags.map { |t| t["name"] }.include?(tag)
|
unless all_tags.map(&:name).include? tag
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
class Hash
|
|
||||||
def stringify_keys_deep!
|
|
||||||
new_hash = {}
|
|
||||||
keys.each do |k|
|
|
||||||
ks = k.respond_to?(:to_s) ? k.to_s : k
|
|
||||||
new_hash[ks] = if values_at(k).first.is_a?(Hash) || values_at(k).first.is_a?(Array)
|
|
||||||
values_at(k).first.send(:stringify_keys_deep!)
|
|
||||||
else
|
|
||||||
values_at(k).first
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
new_hash
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,7 +1,4 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
require "logger"
|
require "logger"
|
||||||
require "rainbow"
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
module Helper
|
module Helper
|
||||||
# @return true if the currently running program is a unit test
|
# @return true if the currently running program is a unit test
|
||||||
@@ -9,7 +6,6 @@ module GitHubChangelogGenerator
|
|||||||
defined? SpecHelper
|
defined? SpecHelper
|
||||||
end
|
end
|
||||||
|
|
||||||
# :nocov:
|
|
||||||
@log ||= if test?
|
@log ||= if test?
|
||||||
Logger.new(nil) # don't show any logs when running tests
|
Logger.new(nil) # don't show any logs when running tests
|
||||||
else
|
else
|
||||||
@@ -17,16 +13,21 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
@log.formatter = proc do |severity, _datetime, _progname, msg|
|
@log.formatter = proc do |severity, _datetime, _progname, msg|
|
||||||
string = "#{msg}\n"
|
string = "#{msg}\n"
|
||||||
case severity
|
|
||||||
when "DEBUG" then Rainbow(string).magenta
|
if severity == "DEBUG"
|
||||||
when "INFO" then Rainbow(string).white
|
string = string.magenta
|
||||||
when "WARN" then Rainbow(string).yellow
|
elsif severity == "INFO"
|
||||||
when "ERROR" then Rainbow(string).red
|
string = string.white
|
||||||
when "FATAL" then Rainbow(string).red.bright
|
elsif severity == "WARN"
|
||||||
else string
|
string = string.yellow
|
||||||
|
elsif severity == "ERROR"
|
||||||
|
string = string.red
|
||||||
|
elsif severity == "FATAL"
|
||||||
|
string = string.red.bold
|
||||||
end
|
end
|
||||||
|
|
||||||
|
string
|
||||||
end
|
end
|
||||||
# :nocov:
|
|
||||||
|
|
||||||
# Logging happens using this method
|
# Logging happens using this method
|
||||||
class << self
|
class << self
|
||||||
|
|||||||
@@ -1,322 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
|
|
||||||
# (such as filtering, validating, e.t.c)
|
|
||||||
#
|
|
||||||
# Example:
|
|
||||||
# fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
|
|
||||||
class OctoFetcher
|
|
||||||
PER_PAGE_NUMBER = 100
|
|
||||||
MAX_THREAD_NUMBER = 1
|
|
||||||
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
|
|
||||||
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
|
|
||||||
"missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
|
|
||||||
NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
|
|
||||||
"This script can make only 50 requests to GitHub API per hour without token!"
|
|
||||||
|
|
||||||
# @param options [Hash] Options passed in
|
|
||||||
# @option options [String] :user GitHub username
|
|
||||||
# @option options [String] :project GitHub project
|
|
||||||
# @option options [String] :since Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. eg. Time.parse("2016-01-01 10:00:00").iso8601
|
|
||||||
# @option options [Boolean] :http_cache Use ActiveSupport::Cache::FileStore to cache http requests
|
|
||||||
# @option options [Boolean] :cache_file If using http_cache, this is the cache file path
|
|
||||||
# @option options [Boolean] :cache_log If using http_cache, this is the cache log file path
|
|
||||||
def initialize(options = {}) # rubocop:disable Metrics/CyclomaticComplexity
|
|
||||||
@options = options || {}
|
|
||||||
@user = @options[:user]
|
|
||||||
@project = @options[:project]
|
|
||||||
@since = @options[:since]
|
|
||||||
@http_cache = @options[:http_cache]
|
|
||||||
@cache_file = @options.fetch(:cache_file, "/tmp/github-changelog-http-cache") if @http_cache
|
|
||||||
@cache_log = @options.fetch(:cache_log, "/tmp/github-changelog-logger.log") if @http_cache
|
|
||||||
init_cache if @http_cache
|
|
||||||
|
|
||||||
@github_token = fetch_github_token
|
|
||||||
|
|
||||||
@request_options = { per_page: PER_PAGE_NUMBER }
|
|
||||||
@github_options = {}
|
|
||||||
@github_options[:access_token] = @github_token unless @github_token.nil?
|
|
||||||
@github_options[:api_endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
|
|
||||||
|
|
||||||
client_type = @options[:github_endpoint].nil? ? Octokit::Client : Octokit::EnterpriseAdminClient
|
|
||||||
@client = client_type.new(@github_options)
|
|
||||||
end
|
|
||||||
|
|
||||||
def init_cache
|
|
||||||
middleware_opts = {
|
|
||||||
serializer: Marshal,
|
|
||||||
store: ActiveSupport::Cache::FileStore.new(@cache_file),
|
|
||||||
logger: Logger.new(@cache_log),
|
|
||||||
shared_cache: false
|
|
||||||
}
|
|
||||||
stack = Faraday::RackBuilder.new do |builder|
|
|
||||||
builder.use Faraday::HttpCache, middleware_opts
|
|
||||||
builder.use Octokit::Response::RaiseError
|
|
||||||
builder.adapter Faraday.default_adapter
|
|
||||||
# builder.response :logger
|
|
||||||
end
|
|
||||||
Octokit.middleware = stack
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetch all tags from repo
|
|
||||||
#
|
|
||||||
# @return [Array <Hash>] array of tags
|
|
||||||
def get_all_tags
|
|
||||||
print "Fetching tags...\r" if @options[:verbose]
|
|
||||||
|
|
||||||
check_github_response { github_fetch_tags }
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns the number of pages for a API call
|
|
||||||
#
|
|
||||||
# @return [Integer] number of pages for this API call in total
|
|
||||||
def calculate_pages(client, method, request_options)
|
|
||||||
# Makes the first API call so that we can call last_response
|
|
||||||
check_github_response do
|
|
||||||
client.send(method, user_project, @request_options.merge(request_options))
|
|
||||||
end
|
|
||||||
|
|
||||||
last_response = client.last_response
|
|
||||||
|
|
||||||
if (last_pg = last_response.rels[:last])
|
|
||||||
parse_url_for_vars(last_pg.href)["page"].to_i
|
|
||||||
else
|
|
||||||
1
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fill input array with tags
|
|
||||||
#
|
|
||||||
# @return [Array <Hash>] array of tags in repo
|
|
||||||
def github_fetch_tags
|
|
||||||
tags = []
|
|
||||||
page_i = 0
|
|
||||||
count_pages = calculate_pages(@client, "tags", {})
|
|
||||||
|
|
||||||
iterate_pages(@client, "tags", {}) do |new_tags|
|
|
||||||
page_i += PER_PAGE_NUMBER
|
|
||||||
print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
|
|
||||||
tags.concat(new_tags)
|
|
||||||
end
|
|
||||||
print_empty_line
|
|
||||||
|
|
||||||
if tags.count == 0
|
|
||||||
Helper.log.warn "Warning: Can't find any tags in repo.\
|
|
||||||
Make sure, that you push tags to remote repo via 'git push --tags'"
|
|
||||||
else
|
|
||||||
Helper.log.info "Found #{tags.count} tags"
|
|
||||||
end
|
|
||||||
# tags are a Sawyer::Resource. Convert to hash
|
|
||||||
tags = tags.map { |h| h.to_hash.stringify_keys_deep! }
|
|
||||||
tags
|
|
||||||
end
|
|
||||||
|
|
||||||
# This method fetch all closed issues and separate them to pull requests and pure issues
|
|
||||||
# (pull request is kind of issue in term of GitHub)
|
|
||||||
#
|
|
||||||
# @return [Tuple] with (issues [Array <Hash>], pull-requests [Array <Hash>])
|
|
||||||
def fetch_closed_issues_and_pr
|
|
||||||
print "Fetching closed issues...\r" if @options[:verbose]
|
|
||||||
issues = []
|
|
||||||
options = {
|
|
||||||
state: "closed",
|
|
||||||
filter: "all",
|
|
||||||
labels: nil
|
|
||||||
}
|
|
||||||
options[:since] = @since unless @since.nil?
|
|
||||||
|
|
||||||
page_i = 0
|
|
||||||
count_pages = calculate_pages(@client, "issues", options)
|
|
||||||
|
|
||||||
iterate_pages(@client, "issues", options) do |new_issues|
|
|
||||||
page_i += PER_PAGE_NUMBER
|
|
||||||
print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
|
|
||||||
issues.concat(new_issues)
|
|
||||||
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
|
||||||
end
|
|
||||||
print_empty_line
|
|
||||||
Helper.log.info "Received issues: #{issues.count}"
|
|
||||||
|
|
||||||
issues = issues.map { |h| h.to_hash.stringify_keys_deep! }
|
|
||||||
|
|
||||||
# separate arrays of issues and pull requests:
|
|
||||||
issues.partition do |x|
|
|
||||||
x["pull_request"].nil?
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetch all pull requests. We need them to detect :merged_at parameter
|
|
||||||
#
|
|
||||||
# @return [Array <Hash>] all pull requests
|
|
||||||
def fetch_closed_pull_requests
|
|
||||||
pull_requests = []
|
|
||||||
options = { state: "closed" }
|
|
||||||
|
|
||||||
unless @options[:release_branch].nil?
|
|
||||||
options[:base] = @options[:release_branch]
|
|
||||||
end
|
|
||||||
|
|
||||||
page_i = 0
|
|
||||||
count_pages = calculate_pages(@client, "pull_requests", options)
|
|
||||||
|
|
||||||
iterate_pages(@client, "pull_requests", options) do |new_pr|
|
|
||||||
page_i += PER_PAGE_NUMBER
|
|
||||||
log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
|
|
||||||
print_in_same_line(log_string)
|
|
||||||
pull_requests.concat(new_pr)
|
|
||||||
end
|
|
||||||
print_empty_line
|
|
||||||
|
|
||||||
Helper.log.info "Pull Request count: #{pull_requests.count}"
|
|
||||||
pull_requests = pull_requests.map { |h| h.to_hash.stringify_keys_deep! }
|
|
||||||
pull_requests
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetch event for all issues and add them to 'events'
|
|
||||||
#
|
|
||||||
# @param [Array] issues
|
|
||||||
# @return [Void]
|
|
||||||
def fetch_events_async(issues)
|
|
||||||
i = 0
|
|
||||||
threads = []
|
|
||||||
|
|
||||||
issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
|
|
||||||
issues_slice.each do |issue|
|
|
||||||
threads << Thread.new do
|
|
||||||
issue["events"] = []
|
|
||||||
iterate_pages(@client, "issue_events", issue["number"], {}) do |new_event|
|
|
||||||
issue["events"].concat(new_event)
|
|
||||||
end
|
|
||||||
issue["events"] = issue["events"].map { |h| h.to_hash.stringify_keys_deep! }
|
|
||||||
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
|
|
||||||
i += 1
|
|
||||||
end
|
|
||||||
end
|
|
||||||
threads.each(&:join)
|
|
||||||
threads = []
|
|
||||||
end
|
|
||||||
|
|
||||||
# to clear line from prev print
|
|
||||||
print_empty_line
|
|
||||||
|
|
||||||
Helper.log.info "Fetching events for issues and PR: #{i}"
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetch tag time from repo
|
|
||||||
#
|
|
||||||
# @param [Hash] tag GitHub data item about a Tag
|
|
||||||
#
|
|
||||||
# @return [Time] time of specified tag
|
|
||||||
def fetch_date_of_tag(tag)
|
|
||||||
commit_data = check_github_response { @client.commit(user_project, tag["commit"]["sha"]) }
|
|
||||||
commit_data = commit_data.to_hash.stringify_keys_deep!
|
|
||||||
|
|
||||||
commit_data["commit"]["committer"]["date"]
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetch commit for specified event
|
|
||||||
#
|
|
||||||
# @return [Hash]
|
|
||||||
def fetch_commit(event)
|
|
||||||
check_github_response do
|
|
||||||
commit = @client.commit(user_project, event["commit_id"])
|
|
||||||
commit = commit.to_hash.stringify_keys_deep!
|
|
||||||
commit
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
# Iterates through all pages until there are no more :next pages to follow
|
|
||||||
# yields the result per page
|
|
||||||
#
|
|
||||||
# @param [Octokit::Client] client
|
|
||||||
# @param [String] method (eg. 'tags')
|
|
||||||
# @return [Integer] total number of pages
|
|
||||||
def iterate_pages(client, method, *args)
|
|
||||||
if args.size == 1 && args.first.is_a?(Hash)
|
|
||||||
request_options = args.delete_at(0)
|
|
||||||
elsif args.size > 1 && args.last.is_a?(Hash)
|
|
||||||
request_options = args.delete_at(args.length - 1)
|
|
||||||
end
|
|
||||||
|
|
||||||
args.push(@request_options.merge(request_options))
|
|
||||||
|
|
||||||
pages = 1
|
|
||||||
|
|
||||||
check_github_response do
|
|
||||||
client.send(method, user_project, *args)
|
|
||||||
end
|
|
||||||
last_response = client.last_response
|
|
||||||
|
|
||||||
yield last_response.data
|
|
||||||
|
|
||||||
until (next_one = last_response.rels[:next]).nil?
|
|
||||||
pages += 1
|
|
||||||
|
|
||||||
last_response = check_github_response { next_one.get }
|
|
||||||
yield last_response.data
|
|
||||||
end
|
|
||||||
|
|
||||||
pages
|
|
||||||
end
|
|
||||||
|
|
||||||
# This is wrapper with rescue block
|
|
||||||
#
|
|
||||||
# @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
|
|
||||||
def check_github_response
|
|
||||||
begin
|
|
||||||
value = yield
|
|
||||||
rescue Octokit::Unauthorized => e
|
|
||||||
Helper.log.error e.message
|
|
||||||
abort "Error: wrong GitHub token"
|
|
||||||
rescue Octokit::Forbidden => e
|
|
||||||
Helper.log.warn e.message
|
|
||||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
|
|
||||||
Helper.log.warn @client.rate_limit
|
|
||||||
end
|
|
||||||
value
|
|
||||||
end
|
|
||||||
|
|
||||||
# Print specified line on the same string
|
|
||||||
#
|
|
||||||
# @param [String] log_string
|
|
||||||
def print_in_same_line(log_string)
|
|
||||||
print log_string + "\r"
|
|
||||||
end
|
|
||||||
|
|
||||||
# Print long line with spaces on same line to clear prev message
|
|
||||||
def print_empty_line
|
|
||||||
print_in_same_line(" ")
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns GitHub token. First try to use variable, provided by --token option,
|
|
||||||
# otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
|
|
||||||
#
|
|
||||||
# @return [String]
|
|
||||||
def fetch_github_token
|
|
||||||
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
|
|
||||||
|
|
||||||
Helper.log.warn NO_TOKEN_PROVIDED unless env_var
|
|
||||||
|
|
||||||
env_var
|
|
||||||
end
|
|
||||||
|
|
||||||
# @return [String] helper to return Github "user/project"
|
|
||||||
def user_project
|
|
||||||
"#{@options[:user]}/#{@options[:project]}"
|
|
||||||
end
|
|
||||||
|
|
||||||
# Parses a URI and returns a hash of all GET variables
|
|
||||||
#
|
|
||||||
# @param [String] uri eg. https://api.github.com/repositories/43914960/tags?page=37&foo=1
|
|
||||||
# @return [Hash] of all GET variables. eg. { 'page' => 37, 'foo' => 1 }
|
|
||||||
def parse_url_for_vars(uri)
|
|
||||||
URI(uri).query.split("&").each_with_object({}) do |get_var, params|
|
|
||||||
k, v = get_var.split("=")
|
|
||||||
params[k] = v
|
|
||||||
params
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
138
lib/github_changelog_generator/parser.rb
Executable file → Normal file
138
lib/github_changelog_generator/parser.rb
Executable file → Normal file
@@ -1,5 +1,4 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
# frozen_string_literal: true
|
|
||||||
require "optparse"
|
require "optparse"
|
||||||
require "pp"
|
require "pp"
|
||||||
require_relative "version"
|
require_relative "version"
|
||||||
@@ -15,7 +14,7 @@ module GitHubChangelogGenerator
|
|||||||
parser = setup_parser(options)
|
parser = setup_parser(options)
|
||||||
parser.parse!
|
parser.parse!
|
||||||
|
|
||||||
fetch_user_and_project(options)
|
user_and_project_from_git(options)
|
||||||
|
|
||||||
abort(parser.banner) unless options[:user] && options[:project]
|
abort(parser.banner) unless options[:user] && options[:project]
|
||||||
|
|
||||||
@@ -24,12 +23,7 @@ module GitHubChangelogGenerator
|
|||||||
options
|
options
|
||||||
end
|
end
|
||||||
|
|
||||||
# If options set to verbose, print the parsed options.
|
# @param [Hash] options to display
|
||||||
#
|
|
||||||
# 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
|
|
||||||
def self.print_options(options)
|
def self.print_options(options)
|
||||||
if options[:verbose]
|
if options[:verbose]
|
||||||
Helper.log.info "Performing task with options:"
|
Helper.log.info "Performing task with options:"
|
||||||
@@ -62,7 +56,7 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
|
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
|
||||||
options[:base] = last
|
options[:base] = last
|
||||||
end
|
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
|
options[:bug_prefix] = v
|
||||||
end
|
end
|
||||||
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
|
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
|
||||||
@@ -98,9 +92,6 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
|
opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
|
||||||
options[:author] = author
|
options[:author] = author
|
||||||
end
|
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|
|
opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
|
||||||
options[:unreleased_only] = v
|
options[:unreleased_only] = v
|
||||||
end
|
end
|
||||||
@@ -131,9 +122,6 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
|
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
|
||||||
options[:exclude_tags] = list
|
options[:exclude_tags] = list
|
||||||
end
|
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|
|
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
|
||||||
options[:since_tag] = v
|
options[:since_tag] = v
|
||||||
end
|
end
|
||||||
@@ -161,15 +149,6 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
|
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
|
options[:release_branch] = release_branch
|
||||||
end
|
end
|
||||||
opts.on("--[no-]http-cache", "Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.") do |http_cache|
|
|
||||||
options[:http_cache] = http_cache
|
|
||||||
end
|
|
||||||
opts.on("--cache-file [CACHE-FILE]", "Filename to use for cache. Default is /tmp/github-changelog-http-cache") do |cache_file|
|
|
||||||
options[:cache_file] = cache_file
|
|
||||||
end
|
|
||||||
opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is /tmp/github-changelog-logger.log") do |cache_log|
|
|
||||||
options[:cache_log] = cache_log
|
|
||||||
end
|
|
||||||
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
|
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
|
||||||
options[:verbose] = v
|
options[:verbose] = v
|
||||||
end
|
end
|
||||||
@@ -185,7 +164,7 @@ module GitHubChangelogGenerator
|
|||||||
parser
|
parser
|
||||||
end
|
end
|
||||||
|
|
||||||
# @return [Hash] Default options
|
# just get default options
|
||||||
def self.default_options
|
def self.default_options
|
||||||
{
|
{
|
||||||
tag1: nil,
|
tag1: nil,
|
||||||
@@ -213,61 +192,41 @@ module GitHubChangelogGenerator
|
|||||||
issue_prefix: "**Closed issues:**",
|
issue_prefix: "**Closed issues:**",
|
||||||
bug_prefix: "**Fixed bugs:**",
|
bug_prefix: "**Fixed bugs:**",
|
||||||
enhancement_prefix: "**Implemented enhancements:**",
|
enhancement_prefix: "**Implemented enhancements:**",
|
||||||
git_remote: "origin",
|
git_remote: "origin"
|
||||||
http_cache: true,
|
|
||||||
cache_file: "/tmp/github-changelog-http-cache",
|
|
||||||
cache_log: "/tmp/github-changelog-logger.log"
|
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
# If `:user` or `:project` not set in options, try setting them
|
def self.user_and_project_from_git(options)
|
||||||
# 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?
|
if options[:user].nil? || options[:project].nil?
|
||||||
user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
|
detect_user_and_project(options, ARGV[0], ARGV[1])
|
||||||
options[:user] ||= user
|
|
||||||
options[:project] ||= project
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
|
# Detects user and project from git
|
||||||
# @param [String] arg0 first argument in cli
|
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
|
||||||
# @param [String] arg1 second argument in cli
|
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
|
||||||
# @return [Array<String>] user and project, or nil if unsuccessful
|
return if options[:user] && options[:project]
|
||||||
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
|
|
||||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
|
||||||
user = "skywinder"
|
|
||||||
project = "changelog_test"
|
|
||||||
else
|
|
||||||
remote = `git config --get remote.#{options[:git_remote]}.url`
|
|
||||||
user, project = user_project_from_remote(remote)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
[user, project]
|
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||||
|
options[:user] = "skywinder"
|
||||||
|
options[:project] = "changelog_test"
|
||||||
|
else
|
||||||
|
remote = `git config --get remote.#{options[:git_remote]}.url`
|
||||||
|
options[:user], options[:project] = user_project_from_remote(remote)
|
||||||
|
end
|
||||||
end
|
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
|
# @param [String] output of git remote command
|
||||||
# GitHub URL, or a 'username/projectname', or
|
# @return [Array] user and project
|
||||||
# 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)
|
def self.user_project_from_option(arg0, arg1, github_site)
|
||||||
user = nil
|
user = nil
|
||||||
project = nil
|
project = nil
|
||||||
github_site ||= "github.com"
|
github_site ||= "github.com"
|
||||||
if arg0 && !arg1
|
if arg0 && !arg1
|
||||||
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or
|
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
|
||||||
# "skywinder/Github-Changelog-Generator" to user and name
|
puts arg0
|
||||||
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
|
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
|
||||||
|
|
||||||
begin
|
begin
|
||||||
@@ -286,40 +245,35 @@ module GitHubChangelogGenerator
|
|||||||
[user, project]
|
[user, project]
|
||||||
end
|
end
|
||||||
|
|
||||||
# These patterns match these formats:
|
# Try to find user and project name from git remote output
|
||||||
#
|
|
||||||
# ```
|
|
||||||
# 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
|
|
||||||
#
|
#
|
||||||
|
# @param [String] output of git remote command
|
||||||
# @return [Array] user and project
|
# @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
|
user = nil
|
||||||
project = nil
|
project = nil
|
||||||
GIT_REMOTE_PATTERNS.each do |git_remote_pattern|
|
remote_structures.each do |regex|
|
||||||
git_remote_pattern =~ git_remote_output
|
matches = Regexp.new(regex).match(remote)
|
||||||
|
|
||||||
if Regexp.last_match
|
if matches && matches[1] && matches[2]
|
||||||
user = Regexp.last_match(:user)
|
puts "Detected user:#{matches[1]}, project:#{matches[2]}"
|
||||||
project = Regexp.last_match(:project)
|
user = matches[1]
|
||||||
break
|
project = matches[2]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
break unless matches.nil?
|
||||||
end
|
end
|
||||||
|
|
||||||
[user, project]
|
[user, project]
|
||||||
|
|||||||
@@ -1,62 +1,33 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
require "pathname"
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
ParserError = Class.new(StandardError)
|
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
|
class ParserFile
|
||||||
# @param options [Hash] options to be configured from file contents
|
def initialize(options)
|
||||||
# @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
|
|
||||||
def initialize(options, file = open_settings_file)
|
|
||||||
@options = options
|
@options = options
|
||||||
@file = file
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sets options using configuration file content
|
|
||||||
def parse!
|
def parse!
|
||||||
return unless @file
|
return unless File.exist?(file)
|
||||||
@file.each_with_index { |line, i| parse_line!(line, i + 1) }
|
|
||||||
@file.close
|
File.readlines(file).each { |line| parse_line!(line) }
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
FILENAME = ".github_changelog_generator"
|
def file
|
||||||
|
@file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
|
||||||
def open_settings_file
|
|
||||||
path = Pathname(File.expand_path(FILENAME))
|
|
||||||
File.open(path) if path.exist?
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def parse_line!(line, line_number)
|
def parse_line!(line)
|
||||||
return if non_configuration_line?(line)
|
key_sym, value = extract_pair(line)
|
||||||
option_name, value = extract_pair(line)
|
value = true if value =~ /^(true|t|yes|y|1)$/i
|
||||||
@options[option_key_for(option_name)] = convert_value(value, option_name)
|
value = false if value =~ /^(false|f|no|n|0)$/i
|
||||||
|
@options[key_sym] = value
|
||||||
rescue
|
rescue
|
||||||
raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
|
raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns true if the line starts with a pound sign or a semi-colon.
|
# Returns a the setting as a symbol and its string value sans newlines.
|
||||||
def non_configuration_line?(line)
|
|
||||||
line =~ /^[\#;]/ || line =~ /^[\s]+$/
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns a the option name as a symbol and its string value sans newlines.
|
|
||||||
#
|
#
|
||||||
# @param line [String] unparsed line from config file
|
# @param line [String] unparsed line from config file
|
||||||
# @return [Array<Symbol, String>]
|
# @return [Array<Symbol, String>]
|
||||||
@@ -64,41 +35,5 @@ module GitHubChangelogGenerator
|
|||||||
key, value = line.split("=", 2)
|
key, value = line.split("=", 2)
|
||||||
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
|
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
|
||||||
end
|
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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
#
|
#
|
||||||
# Author:: Enrico Stahn <mail@enricostahn.com>
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
require "rake"
|
require "rake"
|
||||||
require "rake/tasklib"
|
require "rake/tasklib"
|
||||||
require "github_changelog_generator"
|
require "github_changelog_generator"
|
||||||
@@ -15,7 +14,7 @@ module GitHubChangelogGenerator
|
|||||||
unreleased_only unreleased unreleased_label
|
unreleased_only unreleased unreleased_label
|
||||||
compare_link include_labels exclude_labels
|
compare_link include_labels exclude_labels
|
||||||
bug_labels enhancement_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
|
github_site github_endpoint simple_list
|
||||||
future_release release_branch verbose release_url
|
future_release release_branch verbose release_url
|
||||||
base )
|
base )
|
||||||
@@ -47,7 +46,7 @@ module GitHubChangelogGenerator
|
|||||||
# mimick parse_options
|
# mimick parse_options
|
||||||
options = Parser.default_options
|
options = Parser.default_options
|
||||||
|
|
||||||
Parser.fetch_user_and_project(options)
|
Parser.user_and_project_from_git(options)
|
||||||
|
|
||||||
OPTIONS.each do |o|
|
OPTIONS.each do |o|
|
||||||
v = instance_variable_get("@#{o}")
|
v = instance_variable_get("@#{o}")
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
VERSION = "1.13.1"
|
VERSION = "1.11.0"
|
||||||
end
|
end
|
||||||
|
|||||||
1
spec/files/github_changelog_params_327
Normal file
1
spec/files/github_changelog_params_327
Normal file
@@ -0,0 +1 @@
|
|||||||
|
exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
|
||||||
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]
|
|
||||||
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
#
|
#
|
||||||
# Author:: Enrico Stahn <mail@enricostahn.com>
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
#
|
#
|
||||||
@@ -19,8 +18,6 @@
|
|||||||
require "codeclimate-test-reporter"
|
require "codeclimate-test-reporter"
|
||||||
require "simplecov"
|
require "simplecov"
|
||||||
require "coveralls"
|
require "coveralls"
|
||||||
require "vcr"
|
|
||||||
require "webmock/rspec"
|
|
||||||
|
|
||||||
# This module is only used to check the environment is currently a testing env
|
# This module is only used to check the environment is currently a testing env
|
||||||
module SpecHelper
|
module SpecHelper
|
||||||
@@ -31,32 +28,11 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
|
|||||||
SimpleCov::Formatter::HTMLFormatter,
|
SimpleCov::Formatter::HTMLFormatter,
|
||||||
CodeClimate::TestReporter::Formatter
|
CodeClimate::TestReporter::Formatter
|
||||||
])
|
])
|
||||||
SimpleCov.start do
|
SimpleCov.start
|
||||||
add_filter "gemfiles/"
|
|
||||||
end
|
|
||||||
|
|
||||||
require "github_changelog_generator"
|
require "github_changelog_generator"
|
||||||
require "github_changelog_generator/task"
|
require "github_changelog_generator/task"
|
||||||
|
|
||||||
VCR.configure do |c|
|
|
||||||
c.allow_http_connections_when_no_cassette = true
|
|
||||||
c.cassette_library_dir = "spec/vcr"
|
|
||||||
c.ignore_localhost = true
|
|
||||||
c.default_cassette_options = {
|
|
||||||
record: :new_episodes,
|
|
||||||
serialize_with: :json,
|
|
||||||
preserve_exact_body_bytes: true,
|
|
||||||
decode_compressed_response: true
|
|
||||||
}
|
|
||||||
c.filter_sensitive_data("<GITHUB_TOKEN>") do
|
|
||||||
"token #{ENV.fetch('CHANGELOG_GITHUB_TOKEN') { 'frobnitz' }}"
|
|
||||||
end
|
|
||||||
|
|
||||||
c.configure_rspec_metadata!
|
|
||||||
|
|
||||||
c.hook_into :webmock, :faraday
|
|
||||||
end
|
|
||||||
|
|
||||||
RSpec.configure do |config|
|
RSpec.configure do |config|
|
||||||
config.expect_with :rspec do |expectations|
|
config.expect_with :rspec do |expectations|
|
||||||
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
||||||
|
|||||||
59
spec/unit/fetcher_spec.rb
Normal file
59
spec/unit/fetcher_spec.rb
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
VALID_TOKEN = "0123456789abcdef"
|
||||||
|
INVALID_TOKEN = "0000000000000000"
|
||||||
|
|
||||||
|
DEFAULT_OPTIONS = { user: "skywinder",
|
||||||
|
project: "changelog_test" }
|
||||||
|
|
||||||
|
def options_with_invalid_token
|
||||||
|
options = DEFAULT_OPTIONS
|
||||||
|
options[:token] = INVALID_TOKEN
|
||||||
|
options
|
||||||
|
end
|
||||||
|
|
||||||
|
describe GitHubChangelogGenerator::Fetcher do
|
||||||
|
before(:all) do
|
||||||
|
@fetcher = GitHubChangelogGenerator::Fetcher.new
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#fetch_github_token" do
|
||||||
|
token = GitHubChangelogGenerator::Fetcher::CHANGELOG_GITHUB_TOKEN
|
||||||
|
context "when token in ENV exist" do
|
||||||
|
before { stub_const("ENV", ENV.to_hash.merge(token => VALID_TOKEN)) }
|
||||||
|
subject { @fetcher.fetch_github_token }
|
||||||
|
it { is_expected.to eq(VALID_TOKEN) }
|
||||||
|
end
|
||||||
|
context "when token in ENV is nil" do
|
||||||
|
before { stub_const("ENV", ENV.to_hash.merge(token => nil)) }
|
||||||
|
subject { @fetcher.fetch_github_token }
|
||||||
|
it { is_expected.to be_nil }
|
||||||
|
end
|
||||||
|
context "when token in options and ENV is nil" do
|
||||||
|
before do
|
||||||
|
stub_const("ENV", ENV.to_hash.merge(token => nil))
|
||||||
|
@fetcher = GitHubChangelogGenerator::Fetcher.new(token: VALID_TOKEN)
|
||||||
|
end
|
||||||
|
subject { @fetcher.fetch_github_token }
|
||||||
|
it { is_expected.to eq(VALID_TOKEN) }
|
||||||
|
end
|
||||||
|
context "when token in options and ENV specified" do
|
||||||
|
before do
|
||||||
|
stub_const("ENV", ENV.to_hash.merge(token => "no_matter_what"))
|
||||||
|
@fetcher = GitHubChangelogGenerator::Fetcher.new(token: VALID_TOKEN)
|
||||||
|
end
|
||||||
|
subject { @fetcher.fetch_github_token }
|
||||||
|
it { is_expected.to eq(VALID_TOKEN) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#github_fetch_tags" do
|
||||||
|
context "when wrong token provided" do
|
||||||
|
before do
|
||||||
|
options = options_with_invalid_token
|
||||||
|
@fetcher = GitHubChangelogGenerator::Fetcher.new(options)
|
||||||
|
end
|
||||||
|
it "should raise Unauthorized error" do
|
||||||
|
expect { @fetcher.github_fetch_tags }.to raise_error Github::Error::Unauthorized
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
describe Generator do
|
|
||||||
context "#exclude_issues_by_labels" do
|
|
||||||
let(:label) { { "name" => "BAD" } }
|
|
||||||
let(:issue) { { "labels" => [label] } }
|
|
||||||
let(:good_label) { { "name" => "GOOD" } }
|
|
||||||
let(:good_issue) { { "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,17 +1,19 @@
|
|||||||
# frozen_string_literal: true
|
def tag_mash_with_name(tag)
|
||||||
|
mash_tag = Hashie::Mash.new
|
||||||
|
mash_tag.name = tag
|
||||||
|
mash_tag
|
||||||
|
end
|
||||||
|
|
||||||
|
def tags_mash_from_strings(tags_strings)
|
||||||
|
mash_array = []
|
||||||
|
tags_strings.each do |tag|
|
||||||
|
mash_tag = tag_mash_with_name(tag)
|
||||||
|
mash_array << mash_tag
|
||||||
|
end
|
||||||
|
mash_array
|
||||||
|
end
|
||||||
|
|
||||||
describe GitHubChangelogGenerator::Generator do
|
describe GitHubChangelogGenerator::Generator do
|
||||||
def tag_with_name(tag)
|
|
||||||
{
|
|
||||||
"name" => tag
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
def tags_from_strings(tags_strings)
|
|
||||||
tags_strings.map do |tag|
|
|
||||||
tag_with_name(tag)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#filter_between_tags" do
|
describe "#filter_between_tags" do
|
||||||
context "when between_tags nil" do
|
context "when between_tags nil" do
|
||||||
before do
|
before do
|
||||||
@@ -19,20 +21,20 @@ describe GitHubChangelogGenerator::Generator do
|
|||||||
end
|
end
|
||||||
|
|
||||||
subject do
|
subject do
|
||||||
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
end
|
end
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
end
|
end
|
||||||
context "when between_tags same as input array" do
|
context "when between_tags same as input array" do
|
||||||
before do
|
before do
|
||||||
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
|
||||||
end
|
end
|
||||||
subject do
|
subject do
|
||||||
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
end
|
end
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "when between_tags filled with correct values" do
|
context "when between_tags filled with correct values" do
|
||||||
@@ -40,10 +42,10 @@ describe GitHubChangelogGenerator::Generator do
|
|||||||
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
|
||||||
end
|
end
|
||||||
subject do
|
subject do
|
||||||
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
end
|
end
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "when between_tags filled with invalid values" do
|
context "when between_tags filled with invalid values" do
|
||||||
@@ -52,134 +54,117 @@ describe GitHubChangelogGenerator::Generator do
|
|||||||
end
|
end
|
||||||
|
|
||||||
subject do
|
subject do
|
||||||
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
end
|
end
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "#get_filtered_tags" do
|
describe "#get_filtered_tags" do
|
||||||
subject do
|
subject do
|
||||||
generator.get_filtered_tags(tags_from_strings(%w(1 2 3 4 5)))
|
generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3 4 5)))
|
||||||
end
|
end
|
||||||
|
|
||||||
context "respects between tags" do
|
context "with excluded and between tags" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
|
||||||
|
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 3))) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "#filter_excluded_tags" do
|
describe "#filter_excluded_tags" do
|
||||||
subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
|
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)) }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with non-matching string" do
|
context "with invalid excluded tags" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with matching regex" do
|
context "with regex exclude_tags" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with non-matching regex" do
|
context "with non-matching regex in exclude_tags" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
|
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_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_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_from_strings(%w(1 2 3))) }
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "#filter_since_tag" do
|
describe "#filter_since_tag" do
|
||||||
context "with filled array" do
|
context "with filled array" do
|
||||||
subject { generator.filter_since_tag(tags_from_strings(%w(1 2 3))) }
|
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
|
||||||
context "with valid since tag" do
|
context "with valid since tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with invalid since tag" do
|
context "with invalid since tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with empty array" do
|
context "with empty array" do
|
||||||
subject { generator.filter_since_tag(tags_from_strings(%w())) }
|
subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
|
||||||
|
|
||||||
context "with valid since tag" do
|
context "with valid since tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w())) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with invalid since tag" do
|
context "with invalid since tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w())) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "#filter_due_tag" do
|
describe "#filter_due_tag" do
|
||||||
context "with filled array" do
|
context "with filled array" do
|
||||||
subject { generator.filter_due_tag(tags_from_strings(%w(1 2 3))) }
|
subject { generator.filter_due_tag(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
|
||||||
context "with valid due tag" do
|
context "with valid due tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(3))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(3))) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with invalid due tag" do
|
context "with invalid due tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with empty array" do
|
context "with empty array" do
|
||||||
subject { generator.filter_due_tag(tags_from_strings(%w())) }
|
subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
|
||||||
|
|
||||||
context "with valid due tag" do
|
context "with valid due tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w())) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with invalid due tag" do
|
context "with invalid due tag" do
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
||||||
it { is_expected.to be_a Array }
|
it { is_expected.to be_a Array }
|
||||||
it { is_expected.to match_array(tags_from_strings(%w())) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -194,7 +179,7 @@ describe GitHubChangelogGenerator::Generator do
|
|||||||
end
|
end
|
||||||
context "fetch already filled tag" do
|
context "fetch already filled tag" do
|
||||||
before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
|
before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
|
||||||
subject { @generator.get_time_of_tag tag_with_name("valid_tag") }
|
subject { @generator.get_time_of_tag tag_mash_with_name("valid_tag") }
|
||||||
it { is_expected.to be_a_kind_of(Time) }
|
it { is_expected.to be_a_kind_of(Time) }
|
||||||
it { is_expected.to eq(current_time) }
|
it { is_expected.to eq(current_time) }
|
||||||
end
|
end
|
||||||
@@ -205,7 +190,7 @@ describe GitHubChangelogGenerator::Generator do
|
|||||||
@generator.instance_variable_set :@fetcher, mock
|
@generator.instance_variable_set :@fetcher, mock
|
||||||
end
|
end
|
||||||
subject do
|
subject do
|
||||||
of_tag = @generator.get_time_of_tag(tag_with_name("valid_tag"))
|
of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
|
||||||
of_tag
|
of_tag
|
||||||
end
|
end
|
||||||
it { is_expected.to be_a_kind_of(Time) }
|
it { is_expected.to be_a_kind_of(Time) }
|
||||||
@@ -214,32 +199,31 @@ describe GitHubChangelogGenerator::Generator do
|
|||||||
end
|
end
|
||||||
|
|
||||||
describe "#sort_tags_by_date" do
|
describe "#sort_tags_by_date" do
|
||||||
let(:time1) { Time.now }
|
time1 = Time.now
|
||||||
let(:time2) { Time.now }
|
time2 = Time.now
|
||||||
let(:time3) { Time.now }
|
time3 = Time.now
|
||||||
|
|
||||||
before(:all) do
|
before(:all) do
|
||||||
@generator = GitHubChangelogGenerator::Generator.new
|
@generator = GitHubChangelogGenerator::Generator.new
|
||||||
end
|
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
|
context "sort unsorted tags" do
|
||||||
let(:tags) { tags_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 be_a_kind_of(Array) }
|
||||||
it { is_expected.to match_array(tags.reverse!) }
|
it { is_expected.to match_array(tags.reverse!) }
|
||||||
end
|
end
|
||||||
context "sort sorted tags" do
|
context "sort sorted tags" do
|
||||||
let(:tags) { tags_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 be_a_kind_of(Array) }
|
||||||
it { is_expected.to match_array(tags) }
|
it { is_expected.to match_array(tags) }
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,489 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
VALID_TOKEN = "0123456789abcdef"
|
|
||||||
INVALID_TOKEN = "0000000000000000"
|
|
||||||
|
|
||||||
describe GitHubChangelogGenerator::OctoFetcher do
|
|
||||||
let(:options) do
|
|
||||||
{
|
|
||||||
user: "skywinder",
|
|
||||||
project: "changelog_test"
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
let(:fetcher) { GitHubChangelogGenerator::OctoFetcher.new(options) }
|
|
||||||
|
|
||||||
describe "#fetch_github_token" do
|
|
||||||
token = GitHubChangelogGenerator::OctoFetcher::CHANGELOG_GITHUB_TOKEN
|
|
||||||
context "when token in ENV exist" do
|
|
||||||
before { stub_const("ENV", ENV.to_hash.merge(token => VALID_TOKEN)) }
|
|
||||||
subject { fetcher.send(:fetch_github_token) }
|
|
||||||
it { is_expected.to eq(VALID_TOKEN) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when token in ENV is nil" do
|
|
||||||
before { stub_const("ENV", ENV.to_hash.merge(token => nil)) }
|
|
||||||
subject { fetcher.send(:fetch_github_token) }
|
|
||||||
it { is_expected.to be_nil }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when token in options and ENV is nil" do
|
|
||||||
let(:options) { { token: VALID_TOKEN } }
|
|
||||||
|
|
||||||
before do
|
|
||||||
stub_const("ENV", ENV.to_hash.merge(token => nil))
|
|
||||||
end
|
|
||||||
|
|
||||||
subject { fetcher.send(:fetch_github_token) }
|
|
||||||
it { is_expected.to eq(VALID_TOKEN) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when token in options and ENV specified" do
|
|
||||||
let(:options) { { token: VALID_TOKEN } }
|
|
||||||
|
|
||||||
before do
|
|
||||||
stub_const("ENV", ENV.to_hash.merge(token => "no_matter_what"))
|
|
||||||
end
|
|
||||||
|
|
||||||
subject { fetcher.send(:fetch_github_token) }
|
|
||||||
it { is_expected.to eq(VALID_TOKEN) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#get_all_tags" do
|
|
||||||
context "when github_fetch_tags returns tags" do
|
|
||||||
it "returns tags" do
|
|
||||||
mock_tags = ["tag"]
|
|
||||||
allow(fetcher).to receive(:github_fetch_tags).and_return(mock_tags)
|
|
||||||
expect(fetcher.get_all_tags).to eq(mock_tags)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#github_fetch_tags" do
|
|
||||||
context "when wrong token provided", :vcr do
|
|
||||||
let(:options) do
|
|
||||||
{
|
|
||||||
user: "skywinder",
|
|
||||||
project: "changelog_test",
|
|
||||||
token: INVALID_TOKEN
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
it "should raise Unauthorized error" do
|
|
||||||
expect { fetcher.github_fetch_tags }.to raise_error SystemExit, "Error: wrong GitHub token"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when API call is valid", :vcr do
|
|
||||||
it "should return tags" do
|
|
||||||
expected_tags = [{ "name" => "v0.0.3",
|
|
||||||
"zipball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
|
|
||||||
"tarball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
|
|
||||||
"commit" =>
|
|
||||||
{ "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } },
|
|
||||||
{ "name" => "v0.0.2",
|
|
||||||
"zipball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.2",
|
|
||||||
"tarball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.2",
|
|
||||||
"commit" =>
|
|
||||||
{ "sha" => "9b35bb13dcd15b68e7bcbf10cde5eb937a54f710",
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/9b35bb13dcd15b68e7bcbf10cde5eb937a54f710" } },
|
|
||||||
{ "name" => "v0.0.1",
|
|
||||||
"zipball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.1",
|
|
||||||
"tarball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.1",
|
|
||||||
"commit" =>
|
|
||||||
{ "sha" => "4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d",
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d" } },
|
|
||||||
{ "name" => "0.0.4",
|
|
||||||
"zipball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/zipball/0.0.4",
|
|
||||||
"tarball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/tarball/0.0.4",
|
|
||||||
"commit" =>
|
|
||||||
{ "sha" => "ece0c3ab7142b21064b885061c55ede00ef6ce94",
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/ece0c3ab7142b21064b885061c55ede00ef6ce94" } }]
|
|
||||||
|
|
||||||
expect(fetcher.github_fetch_tags).to eq(expected_tags)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "should return tags count" do
|
|
||||||
tags = fetcher.github_fetch_tags
|
|
||||||
expect(tags.size).to eq(4)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#fetch_closed_issues_and_pr" do
|
|
||||||
context "when API call is valid", :vcr do
|
|
||||||
it "returns issues" do
|
|
||||||
issues, pull_requests = fetcher.fetch_closed_issues_and_pr
|
|
||||||
expect(issues.size).to eq(7)
|
|
||||||
expect(pull_requests.size).to eq(14)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "returns issue with proper key/values" do
|
|
||||||
issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
|
|
||||||
|
|
||||||
expected_issue = { "url" => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
|
|
||||||
"repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
|
|
||||||
"labels_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
|
|
||||||
"comments_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
|
|
||||||
"events_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
|
|
||||||
"html_url" => "https://github.com/skywinder/changelog_test/issues/14",
|
|
||||||
"id" => 95_419_412,
|
|
||||||
"number" => 14,
|
|
||||||
"title" => "Issue closed from commit from PR",
|
|
||||||
"user" =>
|
|
||||||
{ "login" => "skywinder",
|
|
||||||
"id" => 3_356_474,
|
|
||||||
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
|
|
||||||
"gravatar_id" => "",
|
|
||||||
"url" => "https://api.github.com/users/skywinder",
|
|
||||||
"html_url" => "https://github.com/skywinder",
|
|
||||||
"followers_url" => "https://api.github.com/users/skywinder/followers",
|
|
||||||
"following_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/following{/other_user}",
|
|
||||||
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
|
|
||||||
"starred_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
|
|
||||||
"subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions",
|
|
||||||
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
|
|
||||||
"repos_url" => "https://api.github.com/users/skywinder/repos",
|
|
||||||
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
|
|
||||||
"received_events_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/received_events",
|
|
||||||
"type" => "User",
|
|
||||||
"site_admin" => false },
|
|
||||||
"labels" => [],
|
|
||||||
"state" => "closed",
|
|
||||||
"locked" => false,
|
|
||||||
"assignee" => nil,
|
|
||||||
"assignees" => [],
|
|
||||||
"milestone" => nil,
|
|
||||||
"comments" => 0,
|
|
||||||
"created_at" => "2015-07-16T12:06:08Z",
|
|
||||||
"updated_at" => "2015-07-16T12:21:42Z",
|
|
||||||
"closed_at" => "2015-07-16T12:21:42Z",
|
|
||||||
"body" => "" }
|
|
||||||
|
|
||||||
# Convert times to Time
|
|
||||||
expected_issue.each_pair do |k, v|
|
|
||||||
expected_issue[k] = Time.parse(v) if v =~ /^2015-/
|
|
||||||
end
|
|
||||||
|
|
||||||
expect(issues.first).to eq(expected_issue)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "returns pull request with proper key/values" do
|
|
||||||
_issues, pull_requests = fetcher.fetch_closed_issues_and_pr
|
|
||||||
|
|
||||||
expected_pr = { "url" => "https://api.github.com/repos/skywinder/changelog_test/issues/21",
|
|
||||||
"repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
|
|
||||||
"labels_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/21/labels{/name}",
|
|
||||||
"comments_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/21/comments",
|
|
||||||
"events_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/21/events",
|
|
||||||
"html_url" => "https://github.com/skywinder/changelog_test/pull/21",
|
|
||||||
"id" => 124_925_759,
|
|
||||||
"number" => 21,
|
|
||||||
"title" => "Merged br (should appear in change log with #20)",
|
|
||||||
"user" =>
|
|
||||||
{ "login" => "skywinder",
|
|
||||||
"id" => 3_356_474,
|
|
||||||
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
|
|
||||||
"gravatar_id" => "",
|
|
||||||
"url" => "https://api.github.com/users/skywinder",
|
|
||||||
"html_url" => "https://github.com/skywinder",
|
|
||||||
"followers_url" => "https://api.github.com/users/skywinder/followers",
|
|
||||||
"following_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/following{/other_user}",
|
|
||||||
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
|
|
||||||
"starred_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
|
|
||||||
"subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions",
|
|
||||||
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
|
|
||||||
"repos_url" => "https://api.github.com/users/skywinder/repos",
|
|
||||||
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
|
|
||||||
"received_events_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/received_events",
|
|
||||||
"type" => "User",
|
|
||||||
"site_admin" => false },
|
|
||||||
"labels" => [],
|
|
||||||
"state" => "closed",
|
|
||||||
"locked" => false,
|
|
||||||
"assignee" => nil,
|
|
||||||
"assignees" => [],
|
|
||||||
"milestone" => nil,
|
|
||||||
"comments" => 0,
|
|
||||||
"created_at" => "2016-01-05T09:24:08Z",
|
|
||||||
"updated_at" => "2016-01-05T09:26:53Z",
|
|
||||||
"closed_at" => "2016-01-05T09:24:27Z",
|
|
||||||
"pull_request" =>
|
|
||||||
{ "url" => "https://api.github.com/repos/skywinder/changelog_test/pulls/21",
|
|
||||||
"html_url" => "https://github.com/skywinder/changelog_test/pull/21",
|
|
||||||
"diff_url" => "https://github.com/skywinder/changelog_test/pull/21.diff",
|
|
||||||
"patch_url" => "https://github.com/skywinder/changelog_test/pull/21.patch" },
|
|
||||||
"body" =>
|
|
||||||
"to test https://github.com/skywinder/github-changelog-generator/pull/305\r\nshould appear in change log with #20" }
|
|
||||||
|
|
||||||
# Convert times to Time
|
|
||||||
expected_pr.each_pair do |k, v|
|
|
||||||
expected_pr[k] = Time.parse(v) if v =~ /^2016-01/
|
|
||||||
end
|
|
||||||
|
|
||||||
expect(pull_requests.first).to eq(expected_pr)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "returns issues with labels" do
|
|
||||||
issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
|
|
||||||
expected = [[], [], ["Bug"], [], ["enhancement"], ["some label"], []]
|
|
||||||
expect(issues.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "returns pull_requests with labels" do
|
|
||||||
_issues, pull_requests = fetcher.fetch_closed_issues_and_pr
|
|
||||||
expected = [[], [], [], [], [], ["enhancement"], [], [], ["invalid"], [], [], [], [], ["invalid"]]
|
|
||||||
expect(pull_requests.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#fetch_closed_pull_requests" do
|
|
||||||
context "when API call is valid", :vcr do
|
|
||||||
it "returns pull requests" do
|
|
||||||
pull_requests = fetcher.fetch_closed_pull_requests
|
|
||||||
expect(pull_requests.size).to eq(14)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "returns correct pull request keys" do
|
|
||||||
pull_requests = fetcher.fetch_closed_pull_requests
|
|
||||||
|
|
||||||
pr = pull_requests.first
|
|
||||||
expect(pr.keys).to eq(%w(url id html_url diff_url patch_url issue_url number state locked title user body created_at updated_at closed_at merged_at merge_commit_sha assignee assignees milestone commits_url review_comments_url review_comment_url comments_url statuses_url head base _links))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#fetch_events_async" do
|
|
||||||
context "when API call is valid", :vcr do
|
|
||||||
it "populates issues" do
|
|
||||||
issues = [{ "url" => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
|
|
||||||
"repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
|
|
||||||
"labels_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
|
|
||||||
"comments_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
|
|
||||||
"events_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
|
|
||||||
"html_url" => "https://github.com/skywinder/changelog_test/issues/14",
|
|
||||||
"id" => 95_419_412,
|
|
||||||
"number" => 14,
|
|
||||||
"title" => "Issue closed from commit from PR",
|
|
||||||
"user" =>
|
|
||||||
{ "login" => "skywinder",
|
|
||||||
"id" => 3_356_474,
|
|
||||||
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
|
|
||||||
"gravatar_id" => "",
|
|
||||||
"url" => "https://api.github.com/users/skywinder",
|
|
||||||
"html_url" => "https://github.com/skywinder",
|
|
||||||
"followers_url" => "https://api.github.com/users/skywinder/followers",
|
|
||||||
"following_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/following{/other_user}",
|
|
||||||
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
|
|
||||||
"starred_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
|
|
||||||
"subscriptions_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/subscriptions",
|
|
||||||
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
|
|
||||||
"repos_url" => "https://api.github.com/users/skywinder/repos",
|
|
||||||
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
|
|
||||||
"received_events_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/received_events",
|
|
||||||
"type" => "User",
|
|
||||||
"site_admin" => false },
|
|
||||||
"labels" => [],
|
|
||||||
"state" => "closed",
|
|
||||||
"locked" => false,
|
|
||||||
"assignee" => nil,
|
|
||||||
"assignees" => [],
|
|
||||||
"milestone" => nil,
|
|
||||||
"comments" => 0,
|
|
||||||
"created_at" => "2015-07-16T12:06:08Z",
|
|
||||||
"updated_at" => "2015-07-16T12:21:42Z",
|
|
||||||
"closed_at" => "2015-07-16T12:21:42Z",
|
|
||||||
"body" => "" }]
|
|
||||||
|
|
||||||
# Check that they are blank to begin with
|
|
||||||
expect(issues.first["events"]).to be_nil
|
|
||||||
|
|
||||||
fetcher.fetch_events_async(issues)
|
|
||||||
issue_events = issues.first["events"]
|
|
||||||
|
|
||||||
expected_events = [{ "id" => 357_462_189,
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
|
|
||||||
"actor" =>
|
|
||||||
{ "login" => "skywinder",
|
|
||||||
"id" => 3_356_474,
|
|
||||||
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
|
|
||||||
"gravatar_id" => "",
|
|
||||||
"url" => "https://api.github.com/users/skywinder",
|
|
||||||
"html_url" => "https://github.com/skywinder",
|
|
||||||
"followers_url" => "https://api.github.com/users/skywinder/followers",
|
|
||||||
"following_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/following{/other_user}",
|
|
||||||
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
|
|
||||||
"starred_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
|
|
||||||
"subscriptions_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/subscriptions",
|
|
||||||
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
|
|
||||||
"repos_url" => "https://api.github.com/users/skywinder/repos",
|
|
||||||
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
|
|
||||||
"received_events_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/received_events",
|
|
||||||
"type" => "User",
|
|
||||||
"site_admin" => false },
|
|
||||||
"event" => "referenced",
|
|
||||||
"commit_id" => "decfe840d1a1b86e0c28700de5362d3365a29555",
|
|
||||||
"commit_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
|
|
||||||
"created_at" => "2015-07-16T12:21:16Z" },
|
|
||||||
{ "id" => 357_462_542,
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/events/357462542",
|
|
||||||
"actor" =>
|
|
||||||
{ "login" => "skywinder",
|
|
||||||
"id" => 3_356_474,
|
|
||||||
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
|
|
||||||
"gravatar_id" => "",
|
|
||||||
"url" => "https://api.github.com/users/skywinder",
|
|
||||||
"html_url" => "https://github.com/skywinder",
|
|
||||||
"followers_url" => "https://api.github.com/users/skywinder/followers",
|
|
||||||
"following_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/following{/other_user}",
|
|
||||||
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
|
|
||||||
"starred_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
|
|
||||||
"subscriptions_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/subscriptions",
|
|
||||||
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
|
|
||||||
"repos_url" => "https://api.github.com/users/skywinder/repos",
|
|
||||||
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
|
|
||||||
"received_events_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/received_events",
|
|
||||||
"type" => "User",
|
|
||||||
"site_admin" => false },
|
|
||||||
"event" => "closed",
|
|
||||||
"commit_id" => "decfe840d1a1b86e0c28700de5362d3365a29555",
|
|
||||||
"commit_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
|
|
||||||
"created_at" => "2015-07-16T12:21:42Z" }]
|
|
||||||
|
|
||||||
# Convert times to Time
|
|
||||||
expected_events.map! do |event|
|
|
||||||
event.each_pair do |k, v|
|
|
||||||
event[k] = Time.parse(v) if v =~ /^201[56]-/
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
expect(issue_events).to eq(expected_events)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#fetch_date_of_tag" do
|
|
||||||
context "when API call is valid", :vcr do
|
|
||||||
it "returns date" do
|
|
||||||
tag = { "name" => "v0.0.3",
|
|
||||||
"zipball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
|
|
||||||
"tarball_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
|
|
||||||
"commit" =>
|
|
||||||
{ "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } }
|
|
||||||
|
|
||||||
dt = fetcher.fetch_date_of_tag(tag)
|
|
||||||
expect(dt).to eq(Time.parse("2015-03-04 19:01:48 UTC"))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#fetch_commit" do
|
|
||||||
context "when API call is valid", :vcr do
|
|
||||||
it "returns commit" do
|
|
||||||
event = { "id" => 357_462_189,
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
|
|
||||||
"actor" =>
|
|
||||||
{ "login" => "skywinder",
|
|
||||||
"id" => 3_356_474,
|
|
||||||
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
|
|
||||||
"gravatar_id" => "",
|
|
||||||
"url" => "https://api.github.com/users/skywinder",
|
|
||||||
"html_url" => "https://github.com/skywinder",
|
|
||||||
"followers_url" => "https://api.github.com/users/skywinder/followers",
|
|
||||||
"following_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/following{/other_user}",
|
|
||||||
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
|
|
||||||
"starred_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
|
|
||||||
"subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions",
|
|
||||||
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
|
|
||||||
"repos_url" => "https://api.github.com/users/skywinder/repos",
|
|
||||||
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
|
|
||||||
"received_events_url" =>
|
|
||||||
"https://api.github.com/users/skywinder/received_events",
|
|
||||||
"type" => "User",
|
|
||||||
"site_admin" => false },
|
|
||||||
"event" => "referenced",
|
|
||||||
"commit_id" => "decfe840d1a1b86e0c28700de5362d3365a29555",
|
|
||||||
"commit_url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
|
|
||||||
"created_at" => "2015-07-16T12:21:16Z" }
|
|
||||||
commit = fetcher.fetch_commit(event)
|
|
||||||
|
|
||||||
expectations = [
|
|
||||||
%w(sha decfe840d1a1b86e0c28700de5362d3365a29555),
|
|
||||||
["url",
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
|
|
||||||
# OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
|
|
||||||
["html_url",
|
|
||||||
"https://github.com/skywinder/changelog_test/commit/decfe840d1a1b86e0c28700de5362d3365a29555"],
|
|
||||||
["author",
|
|
||||||
{ "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
|
|
||||||
["committer",
|
|
||||||
{ "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
|
|
||||||
["parents",
|
|
||||||
[{ "sha" => "7ec095e5e3caceacedabf44d0b9b10da17c92e51",
|
|
||||||
"url" =>
|
|
||||||
"https://api.github.com/repos/skywinder/changelog_test/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
|
|
||||||
# OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
|
|
||||||
"html_url" =>
|
|
||||||
"https://github.com/skywinder/changelog_test/commit/7ec095e5e3caceacedabf44d0b9b10da17c92e51" }]]
|
|
||||||
]
|
|
||||||
|
|
||||||
expectations.each do |property, val|
|
|
||||||
expect(commit[property]).to eq(val)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,73 +1,54 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
describe GitHubChangelogGenerator::ParserFile do
|
describe GitHubChangelogGenerator::ParserFile do
|
||||||
describe ".github_changelog_generator" do
|
describe ".github_changelog_generator" do
|
||||||
let(:options) { {} }
|
context "when no has file" do
|
||||||
|
let(:options) { {} }
|
||||||
context "when the well-known default file does not exist" do
|
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
|
subject { parse.parse! }
|
||||||
subject { parser.parse! }
|
|
||||||
it { is_expected.to be_nil }
|
it { is_expected.to be_nil }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "when file is empty" do
|
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
|
it "does not change the options" do
|
||||||
expect { parser.parse! }.to_not change { options }
|
expect { parse.parse! }.to_not change { options }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context "when file is incorrect" do
|
context "when file is incorrect" do
|
||||||
|
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
|
||||||
let(:options_before_change) { options.dup }
|
let(:options_before_change) { options.dup }
|
||||||
let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
|
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||||
let(:parser) do
|
it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
|
||||||
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 }
|
|
||||||
end
|
end
|
||||||
|
|
||||||
context "when override default values" do
|
context "when override default values" do
|
||||||
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
|
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
|
||||||
let(:options) { {}.merge(default_options) }
|
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
|
||||||
let(:options_before_change) { options.dup }
|
let(:options_before_change) { options.dup }
|
||||||
let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
|
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
|
|
||||||
|
|
||||||
it "changes the options" do
|
it "changes the options" do
|
||||||
expect { parser.parse! }.to change { options }
|
expect { parse.parse! }.to change { options }
|
||||||
.from(options_before_change)
|
.from(options_before_change)
|
||||||
.to(options_before_change.merge(unreleased_label: "staging",
|
.to(options_before_change.merge(unreleased_label: "staging",
|
||||||
unreleased: false,
|
unreleased: false,
|
||||||
header: "=== Changelog ==="))
|
header: "=== Changelog ==="))
|
||||||
end
|
end
|
||||||
|
|
||||||
context "turns exclude-labels into an Array", bug: "#327" do
|
context "turns exclude-labels into an Array", bug: '#327' do
|
||||||
let(:file) do
|
let(:options) do
|
||||||
StringIO.new(<<EOF
|
{
|
||||||
exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
|
params_file: "spec/files/github_changelog_params_327"
|
||||||
header_label=# My changelog
|
}
|
||||||
EOF
|
|
||||||
)
|
|
||||||
end
|
end
|
||||||
it "reads exclude_labels into an Array" do
|
it "reads exclude_labels into an Array" do
|
||||||
expect { parser.parse! }.to change { options[:exclude_labels] }
|
pending("Related with Bug #327.")
|
||||||
.from(default_options[:exclude_labels])
|
expect { parse.parse! }.to change { options[:exclude_labels] }
|
||||||
|
.from(nil)
|
||||||
.to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
|
.to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
|
||||||
end
|
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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
describe GitHubChangelogGenerator::Parser do
|
describe GitHubChangelogGenerator::Parser do
|
||||||
describe ".user_project_from_remote" do
|
describe ".user_project_from_remote" do
|
||||||
context "when remote is type 1" do
|
context "when remote is type 1" do
|
||||||
@@ -57,26 +56,5 @@ describe GitHubChangelogGenerator::Parser do
|
|||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array([nil, nil]) }
|
it { is_expected.to match_array([nil, nil]) }
|
||||||
end
|
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 do
|
|
||||||
stub_const("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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
#
|
#
|
||||||
# Author:: Enrico Stahn <mail@enricostahn.com>
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
#
|
#
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
|||||||
{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/issues/14/events?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 06:13:06 GMT"],"Content-Type":["application/json; charset=utf-8"],"Transfer-Encoding":["chunked"],"Status":["200 OK"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["37"],"X-Ratelimit-Reset":["1463724861"],"Cache-Control":["public, max-age=60, s-maxage=60"],"Vary":["Accept","Accept-Encoding"],"Etag":["W/\"4d408c4e8053c706d7255563141ccb80\""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Served-By":["2d7a5e35115884240089368322196939"],"X-Github-Request-Id":["6C2F0F69:7F8B:2084B01:573EAAF2"]},"body":{"encoding":"ASCII-8BIT","base64_string":"W3siaWQiOjM1NzQ2MjE4OSwidXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNv\nbS9yZXBvcy9za3l3aW5kZXIvY2hhbmdlbG9nX3Rlc3QvaXNzdWVzL2V2ZW50\ncy8zNTc0NjIxODkiLCJhY3RvciI6eyJsb2dpbiI6InNreXdpbmRlciIsImlk\nIjozMzU2NDc0LCJhdmF0YXJfdXJsIjoiaHR0cHM6Ly9hdmF0YXJzLmdpdGh1\nYnVzZXJjb250ZW50LmNvbS91LzMzNTY0NzQ/dj0zIiwiZ3JhdmF0YXJfaWQi\nOiIiLCJ1cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdp\nbmRlciIsImh0bWxfdXJsIjoiaHR0cHM6Ly9naXRodWIuY29tL3NreXdpbmRl\nciIsImZvbGxvd2Vyc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9mb2xsb3dlcnMiLCJmb2xsb3dpbmdfdXJsIjoiaHR0\ncHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZm9sbG93aW5n\ney9vdGhlcl91c2VyfSIsImdpc3RzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1\nYi5jb20vdXNlcnMvc2t5d2luZGVyL2dpc3Rzey9naXN0X2lkfSIsInN0YXJy\nZWRfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5k\nZXIvc3RhcnJlZHsvb3duZXJ9ey9yZXBvfSIsInN1YnNjcmlwdGlvbnNfdXJs\nIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvc3Vi\nc2NyaXB0aW9ucyIsIm9yZ2FuaXphdGlvbnNfdXJsIjoiaHR0cHM6Ly9hcGku\nZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvb3JncyIsInJlcG9zX3VybCI6\nImh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL3JlcG9z\nIiwiZXZlbnRzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMv\nc2t5d2luZGVyL2V2ZW50c3svcHJpdmFjeX0iLCJyZWNlaXZlZF9ldmVudHNf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIv\ncmVjZWl2ZWRfZXZlbnRzIiwidHlwZSI6IlVzZXIiLCJzaXRlX2FkbWluIjpm\nYWxzZX0sImV2ZW50IjoicmVmZXJlbmNlZCIsImNvbW1pdF9pZCI6ImRlY2Zl\nODQwZDFhMWI4NmUwYzI4NzAwZGU1MzYyZDMzNjVhMjk1NTUiLCJjb21taXRf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS9yZXBvcy9za3l3aW5kZXIv\nY2hhbmdlbG9nX3Rlc3QvY29tbWl0cy9kZWNmZTg0MGQxYTFiODZlMGMyODcw\nMGRlNTM2MmQzMzY1YTI5NTU1IiwiY3JlYXRlZF9hdCI6IjIwMTUtMDctMTZU\nMTI6MjE6MTZaIn0seyJpZCI6MzU3NDYyNTQyLCJ1cmwiOiJodHRwczovL2Fw\naS5naXRodWIuY29tL3JlcG9zL3NreXdpbmRlci9jaGFuZ2Vsb2dfdGVzdC9p\nc3N1ZXMvZXZlbnRzLzM1NzQ2MjU0MiIsImFjdG9yIjp7ImxvZ2luIjoic2t5\nd2luZGVyIiwiaWQiOjMzNTY0NzQsImF2YXRhcl91cmwiOiJodHRwczovL2F2\nYXRhcnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tL3UvMzM1NjQ3ND92PTMiLCJn\ncmF2YXRhcl9pZCI6IiIsInVybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20v\ndXNlcnMvc2t5d2luZGVyIiwiaHRtbF91cmwiOiJodHRwczovL2dpdGh1Yi5j\nb20vc2t5d2luZGVyIiwiZm9sbG93ZXJzX3VybCI6Imh0dHBzOi8vYXBpLmdp\ndGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL2ZvbGxvd2VycyIsImZvbGxvd2lu\nZ191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRl\nci9mb2xsb3dpbmd7L290aGVyX3VzZXJ9IiwiZ2lzdHNfdXJsIjoiaHR0cHM6\nLy9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZ2lzdHN7L2dpc3Rf\naWR9Iiwic3RhcnJlZF91cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9zdGFycmVkey9vd25lcn17L3JlcG99Iiwic3Vic2Ny\naXB0aW9uc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3Nr\neXdpbmRlci9zdWJzY3JpcHRpb25zIiwib3JnYW5pemF0aW9uc191cmwiOiJo\ndHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRlci9vcmdzIiwi\ncmVwb3NfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3\naW5kZXIvcmVwb3MiLCJldmVudHNfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHVi\nLmNvbS91c2Vycy9za3l3aW5kZXIvZXZlbnRzey9wcml2YWN5fSIsInJlY2Vp\ndmVkX2V2ZW50c191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJz\nL3NreXdpbmRlci9yZWNlaXZlZF9ldmVudHMiLCJ0eXBlIjoiVXNlciIsInNp\ndGVfYWRtaW4iOmZhbHNlfSwiZXZlbnQiOiJjbG9zZWQiLCJjb21taXRfaWQi\nOiJkZWNmZTg0MGQxYTFiODZlMGMyODcwMGRlNTM2MmQzMzY1YTI5NTU1Iiwi\nY29tbWl0X3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vcmVwb3Mvc2t5\nd2luZGVyL2NoYW5nZWxvZ190ZXN0L2NvbW1pdHMvZGVjZmU4NDBkMWExYjg2\nZTBjMjg3MDBkZTUzNjJkMzM2NWEyOTU1NSIsImNyZWF0ZWRfYXQiOiIyMDE1\nLTA3LTE2VDEyOjIxOjQyWiJ9XQ==\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 06:13:10 GMT"}],"recorded_with":"VCR 3.0.1"}
|
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
|||||||
{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 05:47:03 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["42"],"X-Ratelimit-Reset":["1463724861"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["6C2F0F69:1271A:B8980B7:573EA4D6"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 05:47:07 GMT"}],"recorded_with":"VCR 3.0.1"}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Sat, 02 Jul 2016 14:13:57 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["59"],"X-Ratelimit-Reset":["1467472437"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["54DBAB83:300E:76DBC85:5777CC25"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Sat, 02 Jul 2016 14:13:58 GMT"}],"recorded_with":"VCR 3.0.1"}
|
|
||||||
Reference in New Issue
Block a user