Compare commits
3 Commits
v1.15.0.pr
...
abonas-fix
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8941eb8280 | ||
|
|
905a04fb75 | ||
|
|
30b7f39c40 |
@@ -1,12 +0,0 @@
|
|||||||
engines:
|
|
||||||
duplication:
|
|
||||||
enabled: true
|
|
||||||
config:
|
|
||||||
languages:
|
|
||||||
- ruby
|
|
||||||
rubocop:
|
|
||||||
enabled: true
|
|
||||||
ratings:
|
|
||||||
paths:
|
|
||||||
- "**.rb"
|
|
||||||
exclude_paths:
|
|
||||||
12
.gitignore
vendored
12
.gitignore
vendored
@@ -1,12 +0,0 @@
|
|||||||
bin/
|
|
||||||
!bin/git-generate-changelog
|
|
||||||
!bin/github_changelog_generator
|
|
||||||
pkg/
|
|
||||||
coverage/
|
|
||||||
.bundle
|
|
||||||
spec/*.lock
|
|
||||||
doc
|
|
||||||
.yardoc
|
|
||||||
Gemfile.lock
|
|
||||||
gemfiles/Gemfile.2_4_0.lock
|
|
||||||
gemfiles/Gemfile.jruby-9.1.5.0.lock
|
|
||||||
|
|||||||
66
.rubocop.yml
66
.rubocop.yml
@@ -1,19 +1,8 @@
|
|||||||
inherit_from: .rubocop_todo.yml
|
inherit_from: .rubocop_todo.yml
|
||||||
|
|
||||||
AllCops:
|
|
||||||
TargetRubyVersion: 2.2
|
|
||||||
DisplayCopNames: true
|
|
||||||
DisplayStyleGuide: true
|
|
||||||
Exclude:
|
|
||||||
- 'vendor/**/*'
|
|
||||||
- 'gemfiles/**/*'
|
|
||||||
|
|
||||||
Metrics/LineLength:
|
Metrics/LineLength:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
Performance/RegexpMatch:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
#http://viget.com/extend/just-use-double-quoted-ruby-strings
|
#http://viget.com/extend/just-use-double-quoted-ruby-strings
|
||||||
Style/StringLiterals:
|
Style/StringLiterals:
|
||||||
EnforcedStyle: double_quotes
|
EnforcedStyle: double_quotes
|
||||||
@@ -25,58 +14,3 @@ Metrics/ClassLength:
|
|||||||
# Configuration parameters: CountComments.
|
# Configuration parameters: CountComments.
|
||||||
Metrics/MethodLength:
|
Metrics/MethodLength:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
Naming/FileName:
|
|
||||||
Exclude:
|
|
||||||
- 'bin/git-generate-changelog'
|
|
||||||
|
|
||||||
#TODOS
|
|
||||||
# Offense count: 14
|
|
||||||
Metrics/AbcSize:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 1
|
|
||||||
Naming/AccessorMethodName:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 10
|
|
||||||
Style/Documentation:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 1
|
|
||||||
# Configuration parameters: MinBodyLength.
|
|
||||||
Style/GuardClause:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 2
|
|
||||||
# Cop supports --auto-correct.
|
|
||||||
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
|
||||||
# SupportedStyles: skip_modifier_ifs, always
|
|
||||||
Style/Next:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 3
|
|
||||||
# Cop supports --auto-correct.
|
|
||||||
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
|
|
||||||
# SupportedStyles: slashes, percent_r, mixed
|
|
||||||
Style/RegexpLiteral:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
Style/MutableConstant:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# "Use idx.positive? instead of idx > 0."
|
|
||||||
Style/NumericPredicate:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
Style/SafeNavigation:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
Metrics/BlockLength:
|
|
||||||
Exclude:
|
|
||||||
- 'spec/**/*'
|
|
||||||
|
|
||||||
# Re-enable when merged; https://github.com/bbatsov/rubocop/pull/4756
|
|
||||||
Lint/InterpolationCheck:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,15 +1,42 @@
|
|||||||
# This configuration was generated by
|
# This configuration was generated by `rubocop --auto-gen-config`
|
||||||
# `rubocop --auto-gen-config`
|
# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
|
||||||
# on 2016-09-30 23:56:15 +0200 using RuboCop version 0.43.0.
|
|
||||||
# The point is for the user to remove these configuration records
|
# The point is for the user to remove these configuration records
|
||||||
# one by one as the offenses are removed from the code base.
|
# one by one as the offenses are removed from the code base.
|
||||||
# Note that changes in the inspected code, or installation of new
|
# Note that changes in the inspected code, or installation of new
|
||||||
# versions of RuboCop, may require this file to be generated again.
|
# versions of RuboCop, may require this file to be generated again.
|
||||||
|
|
||||||
|
# Offense count: 13
|
||||||
|
Metrics/AbcSize:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
# Offense count: 1
|
# Offense count: 1
|
||||||
Metrics/CyclomaticComplexity:
|
Metrics/CyclomaticComplexity:
|
||||||
Max: 7
|
Max: 7
|
||||||
|
|
||||||
# Offense count: 2
|
# Offense count: 1
|
||||||
Metrics/PerceivedComplexity:
|
Metrics/PerceivedComplexity:
|
||||||
Max: 8
|
Max: 8
|
||||||
|
|
||||||
|
# Offense count: 2
|
||||||
|
Style/AccessorMethodName:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 10
|
||||||
|
Style/Documentation:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 1
|
||||||
|
# Configuration parameters: MinBodyLength.
|
||||||
|
Style/GuardClause:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 1
|
||||||
|
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
||||||
|
Style/Next:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 3
|
||||||
|
# Cop supports --auto-correct.
|
||||||
|
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
|
||||||
|
Style/RegexpLiteral:
|
||||||
|
Enabled: false
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
2.4.0
|
|
||||||
42
.travis.yml
42
.travis.yml
@@ -1,35 +1,17 @@
|
|||||||
|
sudo: false
|
||||||
|
cache: bundler
|
||||||
language: ruby
|
language: ruby
|
||||||
cache:
|
rvm:
|
||||||
bundler: true
|
- 2.1.0
|
||||||
before_install:
|
script:
|
||||||
- gem install bundler
|
- bundle exec rake
|
||||||
matrix:
|
notifications:
|
||||||
include:
|
email:
|
||||||
- rvm: 2.2.8
|
recipients:
|
||||||
install: true # This skips 'bundle install'
|
- sky4winder+githubchangeloggenerator@gmail.com
|
||||||
script: gem build github_changelog_generator && gem install *.gem
|
on_success: never
|
||||||
- rvm: 2.2.8
|
on_failure: change
|
||||||
install: true # This skips 'bundle install'
|
|
||||||
script: gem build github_changelog_generator && bundle install
|
|
||||||
gemfile: spec/install-gem-in-bundler.gemfile
|
|
||||||
- rvm: 2.3.5
|
|
||||||
- rvm: 2.4.2
|
|
||||||
- rvm: jruby-9.1.13.0
|
|
||||||
jdk: oraclejdk8
|
|
||||||
env:
|
|
||||||
- JRUBY_OPTS=--debug
|
|
||||||
- rvm: jruby-head
|
|
||||||
jdk: oraclejdk8
|
|
||||||
env:
|
|
||||||
- JRUBY_OPTS=--debug
|
|
||||||
- DEBUG=1
|
|
||||||
allow_failures:
|
|
||||||
- rvm: jruby-head
|
|
||||||
fast_finish: true
|
|
||||||
|
|
||||||
addons:
|
addons:
|
||||||
code_climate:
|
code_climate:
|
||||||
repo_token:
|
repo_token:
|
||||||
secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=
|
secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=
|
||||||
after_success:
|
|
||||||
- bundle exec codeclimate-test-reporter
|
|
||||||
|
|||||||
419
CHANGELOG.md
419
CHANGELOG.md
@@ -1,408 +1,14 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
## [v1.14.3](https://github.com/skywinder/github-changelog-generator/tree/v1.14.3) (2016-12-31)
|
## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.2...v1.14.3)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...HEAD)
|
||||||
|
|
||||||
- Use Octokit::Client for both .com and Enterprise [\#455](https://github.com/skywinder/github-changelog-generator/pull/455) ([eliperkins](https://github.com/eliperkins))
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- Last tag contains too many PRs [\#291](https://github.com/skywinder/github-changelog-generator/issues/291)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- CodeClimate configuration file [\#465](https://github.com/skywinder/github-changelog-generator/pull/465) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Travis: Build against 2.4.0 [\#464](https://github.com/skywinder/github-changelog-generator/pull/464) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Travis: add jruby-head, 2.4.0-rc1 [\#463](https://github.com/skywinder/github-changelog-generator/pull/463) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Gemfiles for building versions separately dropped [\#461](https://github.com/skywinder/github-changelog-generator/pull/461) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Order Gemfile gems A-Z; add ruby version marker [\#460](https://github.com/skywinder/github-changelog-generator/pull/460) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- README: Documentation update about RakeTask params and how to translate labels [\#454](https://github.com/skywinder/github-changelog-generator/pull/454) ([edusantana](https://github.com/edusantana))
|
|
||||||
- Travis: Use ruby 2.3.3 and 2.2.6 [\#452](https://github.com/skywinder/github-changelog-generator/pull/452) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
## [v1.14.2](https://github.com/skywinder/github-changelog-generator/tree/v1.14.2) (2016-11-12)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.1...v1.14.2)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- OctoFetcher: Moved repositories fail explicitly [\#449](https://github.com/skywinder/github-changelog-generator/pull/449) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- Error: can't convert Sawyer::Resource to Array when iterating over a 301 Moved Permanently [\#448](https://github.com/skywinder/github-changelog-generator/issues/448)
|
|
||||||
|
|
||||||
## [v1.14.1](https://github.com/skywinder/github-changelog-generator/tree/v1.14.1) (2016-11-06)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.0...v1.14.1)
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- multi\_json is required but is listed as a test dependency [\#444](https://github.com/skywinder/github-changelog-generator/issues/444)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Add multi\_json as a runtime dependency [\#445](https://github.com/skywinder/github-changelog-generator/pull/445) ([rnelson0](https://github.com/rnelson0))
|
|
||||||
|
|
||||||
## [v1.14.0](https://github.com/skywinder/github-changelog-generator/tree/v1.14.0) (2016-11-05)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.13.2...v1.14.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- On OctoKit::Forbidden error: retry with exponential backoff [\#434](https://github.com/skywinder/github-changelog-generator/pull/434) ([awaage](https://github.com/awaage))
|
|
||||||
- Use octokit, carrying awaage commits [\#422](https://github.com/skywinder/github-changelog-generator/pull/422) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Add option to show selected labels in the issue line [\#418](https://github.com/skywinder/github-changelog-generator/pull/418) ([aih](https://github.com/aih))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- unreleased and unreleased-label [\#374](https://github.com/skywinder/github-changelog-generator/issues/374)
|
|
||||||
- Problems installing 1.11.7 on Windows when git absent [\#349](https://github.com/skywinder/github-changelog-generator/issues/349)
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- broken issue-line-labels in log [\#442](https://github.com/skywinder/github-changelog-generator/issues/442)
|
|
||||||
- Broken multi hyphen options in param file [\#440](https://github.com/skywinder/github-changelog-generator/issues/440)
|
|
||||||
- Install error on Mac: "rack requires Ruby version \>= 2.2.2" [\#425](https://github.com/skywinder/github-changelog-generator/issues/425)
|
|
||||||
- Changelog includes issues going back months too far [\#394](https://github.com/skywinder/github-changelog-generator/issues/394)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Fixed issue \#442 - broken issue-line-labels in log. [\#443](https://github.com/skywinder/github-changelog-generator/pull/443) ([thorsteneckel](https://github.com/thorsteneckel))
|
|
||||||
- Fixed issue \#440 - broken multi hyphen options in param file. [\#441](https://github.com/skywinder/github-changelog-generator/pull/441) ([thorsteneckel](https://github.com/thorsteneckel))
|
|
||||||
- Option --unreleased-label explained [\#439](https://github.com/skywinder/github-changelog-generator/pull/439) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Fixed issue \#304 - entries of previous tags are included. [\#438](https://github.com/skywinder/github-changelog-generator/pull/438) ([thorsteneckel](https://github.com/thorsteneckel))
|
|
||||||
- man page: Add undescribed options [\#437](https://github.com/skywinder/github-changelog-generator/pull/437) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- On GitHub MAX\_THREAD\_NUMBER is 25 [\#433](https://github.com/skywinder/github-changelog-generator/pull/433) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- OctoFetcher, Options: Refactoring [\#432](https://github.com/skywinder/github-changelog-generator/pull/432) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Fix typo in Readme [\#431](https://github.com/skywinder/github-changelog-generator/pull/431) ([rmtheis](https://github.com/rmtheis))
|
|
||||||
- Fix: Turn Sawyer method into String-keyed hash access [\#429](https://github.com/skywinder/github-changelog-generator/pull/429) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Spec: Test a url helper function [\#428](https://github.com/skywinder/github-changelog-generator/pull/428) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Rubocop TODO file regenerated [\#427](https://github.com/skywinder/github-changelog-generator/pull/427) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Drop a stray Markdown file [\#426](https://github.com/skywinder/github-changelog-generator/pull/426) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Travis: Add JRuby 9.1.5.0 to matrix [\#424](https://github.com/skywinder/github-changelog-generator/pull/424) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
## [v1.13.2](https://github.com/skywinder/github-changelog-generator/tree/v1.13.2) (2016-09-29)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.2...v1.13.2)
|
|
||||||
|
|
||||||
## [1.13.2](https://github.com/skywinder/github-changelog-generator/tree/1.13.2) (2016-09-29)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.1...1.13.2)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Replace GPL'd colorize gem with MIT-licensed rainbow [\#408](https://github.com/skywinder/github-changelog-generator/pull/408) ([jamesc](https://github.com/jamesc))
|
|
||||||
- Limit number of simultaneous requests to 25 [\#407](https://github.com/skywinder/github-changelog-generator/pull/407) ([jkeiser](https://github.com/jkeiser))
|
|
||||||
- Report actual github error when rate limit exceeded [\#405](https://github.com/skywinder/github-changelog-generator/pull/405) ([jkeiser](https://github.com/jkeiser))
|
|
||||||
- Make error messages print on error [\#404](https://github.com/skywinder/github-changelog-generator/pull/404) ([jkeiser](https://github.com/jkeiser))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- Fetching events for issues and PRs triggers abuse rate limits [\#406](https://github.com/skywinder/github-changelog-generator/issues/406)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Add bump gem to development deps [\#423](https://github.com/skywinder/github-changelog-generator/pull/423) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Skip logger helper in coverage [\#421](https://github.com/skywinder/github-changelog-generator/pull/421) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Travis: Test on 2.4.0-preview2 [\#420](https://github.com/skywinder/github-changelog-generator/pull/420) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Travis: Collecting the config, gemspec: extract development deps to Gemfile [\#417](https://github.com/skywinder/github-changelog-generator/pull/417) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Update README.md [\#415](https://github.com/skywinder/github-changelog-generator/pull/415) ([dijonkitchen](https://github.com/dijonkitchen))
|
|
||||||
- README: Add Gitter badge [\#413](https://github.com/skywinder/github-changelog-generator/pull/413) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- CircleCI hook for Gitter notification [\#411](https://github.com/skywinder/github-changelog-generator/pull/411) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Spec: avoid Ruby warning about already-defined constant [\#409](https://github.com/skywinder/github-changelog-generator/pull/409) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
## [1.13.1](https://github.com/skywinder/github-changelog-generator/tree/1.13.1) (2016-07-22)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.0...1.13.1)
|
|
||||||
|
|
||||||
**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:**
|
|
||||||
|
|
||||||
- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Fix installation by not running the specs - which have dependencies [\#337](https://github.com/skywinder/github-changelog-generator/pull/337) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.11.1](https://github.com/skywinder/github-changelog-generator/tree/1.11.1) (2016-02-25)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.0...1.11.1)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Add rubocop and rspec as runtime dependencies [\#336](https://github.com/skywinder/github-changelog-generator/pull/336) ([jkeiser](https://github.com/jkeiser))
|
|
||||||
- \[Refactor\] ParserFile class use Pathname [\#334](https://github.com/skywinder/github-changelog-generator/pull/334) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- \[Refactor\] Generator\#exclude\_issues\_by\_labels simpler, tested [\#332](https://github.com/skywinder/github-changelog-generator/pull/332) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
## [1.11.0](https://github.com/skywinder/github-changelog-generator/tree/1.11.0) (2016-02-24)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.5...1.11.0)
|
|
||||||
|
|
||||||
## [1.10.5](https://github.com/skywinder/github-changelog-generator/tree/1.10.5) (2016-02-24)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.4...1.10.5)
|
|
||||||
|
|
||||||
## [1.10.4](https://github.com/skywinder/github-changelog-generator/tree/1.10.4) (2016-02-24)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.3...1.10.4)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- Rake and Bundler as runtime deps [\#333](https://github.com/skywinder/github-changelog-generator/pull/333) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Test case for \#327 [\#331](https://github.com/skywinder/github-changelog-generator/pull/331) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Fix crash installing on systems without overcommit [\#330](https://github.com/skywinder/github-changelog-generator/pull/330) ([jkeiser](https://github.com/jkeiser))
|
|
||||||
|
|
||||||
## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
|
|
||||||
|
|
||||||
## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
|
|
||||||
|
|
||||||
## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- We should add a git-generate-changelog command. [\#255](https://github.com/skywinder/github-changelog-generator/issues/255)
|
|
||||||
- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
|
|
||||||
- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
|
|
||||||
|
|
||||||
## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
|
||||||
- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
|
||||||
- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
|
||||||
- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
|
|
||||||
|
|
||||||
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
|
|
||||||
|
|
||||||
## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
|
|
||||||
|
|
||||||
## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- Sending OATH through -t fails [\#274](https://github.com/skywinder/github-changelog-generator/issues/274)
|
|
||||||
|
|
||||||
## [1.8.3](https://github.com/skywinder/github-changelog-generator/tree/1.8.3) (2015-08-31)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.2...1.8.3)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Do not alter pull\_requests while iterating on it [\#271](https://github.com/skywinder/github-changelog-generator/pull/271) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
|
|
||||||
|
|
||||||
**Closed issues:**
|
|
||||||
|
|
||||||
- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
|
|
||||||
- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
|
|
||||||
- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
|
|
||||||
- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
|
|
||||||
- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
|
- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
|
||||||
- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
|
- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
|
||||||
- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
|
- Add --since-tag, close [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
|
||||||
|
|
||||||
## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
|
## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
|
||||||
@@ -483,7 +89,6 @@
|
|||||||
|
|
||||||
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
|
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
|
||||||
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
|
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
|
||||||
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
|
||||||
|
|
||||||
**Closed issues:**
|
**Closed issues:**
|
||||||
|
|
||||||
@@ -493,6 +98,7 @@
|
|||||||
|
|
||||||
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
|
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
|
||||||
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
||||||
|
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
||||||
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
|
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
|
||||||
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
||||||
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
|
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
|
||||||
@@ -508,7 +114,7 @@
|
|||||||
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
|
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
|
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
@@ -519,7 +125,7 @@
|
|||||||
|
|
||||||
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
|
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
|
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
@@ -593,7 +199,7 @@
|
|||||||
## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
|
## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
|
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
|
||||||
|
|
||||||
@@ -610,12 +216,15 @@
|
|||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
|
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
|
||||||
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
|
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
|
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
|
||||||
|
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||||
|
|
||||||
## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
|
## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
|
||||||
@@ -649,6 +258,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)
|
||||||
|
|
||||||
@@ -720,7 +333,6 @@
|
|||||||
|
|
||||||
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
|
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
|
||||||
- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
|
- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
|
||||||
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
@@ -728,6 +340,7 @@
|
|||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||||
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
|
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
|
## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
|
||||||
|
|||||||
24
Gemfile
24
Gemfile
@@ -1,29 +1,11 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
|
|
||||||
ruby RUBY_VERSION
|
|
||||||
|
|
||||||
gemspec
|
gemspec
|
||||||
|
|
||||||
group :development, :test do
|
|
||||||
gem "bundler"
|
|
||||||
gem "overcommit", ">= 0.31"
|
|
||||||
gem "rake"
|
|
||||||
gem "rubocop", ">= 0.50"
|
|
||||||
end
|
|
||||||
|
|
||||||
group :development do
|
|
||||||
gem "bump"
|
|
||||||
end
|
|
||||||
|
|
||||||
group :test do
|
group :test do
|
||||||
gem "codeclimate-test-reporter", "~> 1.0"
|
gem "rspec", "~>3.2"
|
||||||
|
gem "rubocop", "~>0.31"
|
||||||
gem "coveralls", "~>0.8", require: false
|
gem "coveralls", "~>0.8", require: false
|
||||||
gem "json"
|
|
||||||
gem "multi_json"
|
|
||||||
gem "rspec", "< 4"
|
|
||||||
gem "simplecov", "~>0.10", require: false
|
gem "simplecov", "~>0.10", require: false
|
||||||
gem "vcr"
|
gem "codeclimate-test-reporter", "~>0.4"
|
||||||
gem "webmock"
|
|
||||||
end
|
end
|
||||||
|
|||||||
114
Gemfile.lock
Normal file
114
Gemfile.lock
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
PATH
|
||||||
|
remote: .
|
||||||
|
specs:
|
||||||
|
github_changelog_generator (1.7.0)
|
||||||
|
colorize (~> 0.7)
|
||||||
|
github_api (~> 0.12)
|
||||||
|
|
||||||
|
GEM
|
||||||
|
remote: https://rubygems.org/
|
||||||
|
specs:
|
||||||
|
addressable (2.3.8)
|
||||||
|
ast (2.0.0)
|
||||||
|
astrolabe (1.3.1)
|
||||||
|
parser (~> 2.2)
|
||||||
|
codeclimate-test-reporter (0.4.7)
|
||||||
|
simplecov (>= 0.7.1, < 1.0.0)
|
||||||
|
colorize (0.7.7)
|
||||||
|
coveralls (0.8.2)
|
||||||
|
json (~> 1.8)
|
||||||
|
rest-client (>= 1.6.8, < 2)
|
||||||
|
simplecov (~> 0.10.0)
|
||||||
|
term-ansicolor (~> 1.3)
|
||||||
|
thor (~> 0.19.1)
|
||||||
|
descendants_tracker (0.0.4)
|
||||||
|
thread_safe (~> 0.3, >= 0.3.1)
|
||||||
|
diff-lcs (1.2.5)
|
||||||
|
docile (1.1.5)
|
||||||
|
domain_name (0.5.24)
|
||||||
|
unf (>= 0.0.5, < 1.0.0)
|
||||||
|
faraday (0.9.1)
|
||||||
|
multipart-post (>= 1.2, < 3)
|
||||||
|
github_api (0.12.3)
|
||||||
|
addressable (~> 2.3)
|
||||||
|
descendants_tracker (~> 0.0.4)
|
||||||
|
faraday (~> 0.8, < 0.10)
|
||||||
|
hashie (>= 3.3)
|
||||||
|
multi_json (>= 1.7.5, < 2.0)
|
||||||
|
nokogiri (~> 1.6.3)
|
||||||
|
oauth2
|
||||||
|
hashie (3.4.2)
|
||||||
|
http-cookie (1.0.2)
|
||||||
|
domain_name (~> 0.5)
|
||||||
|
json (1.8.3)
|
||||||
|
jwt (1.5.1)
|
||||||
|
mime-types (2.6.1)
|
||||||
|
mini_portile (0.6.2)
|
||||||
|
multi_json (1.11.2)
|
||||||
|
multi_xml (0.5.5)
|
||||||
|
multipart-post (2.0.0)
|
||||||
|
netrc (0.10.3)
|
||||||
|
nokogiri (1.6.6.2)
|
||||||
|
mini_portile (~> 0.6.0)
|
||||||
|
oauth2 (1.0.0)
|
||||||
|
faraday (>= 0.8, < 0.10)
|
||||||
|
jwt (~> 1.0)
|
||||||
|
multi_json (~> 1.3)
|
||||||
|
multi_xml (~> 0.5)
|
||||||
|
rack (~> 1.2)
|
||||||
|
parser (2.2.2.6)
|
||||||
|
ast (>= 1.1, < 3.0)
|
||||||
|
powerpack (0.1.1)
|
||||||
|
rack (1.6.4)
|
||||||
|
rainbow (2.0.0)
|
||||||
|
rake (10.4.2)
|
||||||
|
rest-client (1.8.0)
|
||||||
|
http-cookie (>= 1.0.2, < 2.0)
|
||||||
|
mime-types (>= 1.16, < 3.0)
|
||||||
|
netrc (~> 0.7)
|
||||||
|
rspec (3.3.0)
|
||||||
|
rspec-core (~> 3.3.0)
|
||||||
|
rspec-expectations (~> 3.3.0)
|
||||||
|
rspec-mocks (~> 3.3.0)
|
||||||
|
rspec-core (3.3.2)
|
||||||
|
rspec-support (~> 3.3.0)
|
||||||
|
rspec-expectations (3.3.1)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.3.0)
|
||||||
|
rspec-mocks (3.3.2)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.3.0)
|
||||||
|
rspec-support (3.3.0)
|
||||||
|
rubocop (0.32.1)
|
||||||
|
astrolabe (~> 1.3)
|
||||||
|
parser (>= 2.2.2.5, < 3.0)
|
||||||
|
powerpack (~> 0.1)
|
||||||
|
rainbow (>= 1.99.1, < 3.0)
|
||||||
|
ruby-progressbar (~> 1.4)
|
||||||
|
ruby-progressbar (1.7.5)
|
||||||
|
simplecov (0.10.0)
|
||||||
|
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.5.4)
|
||||||
|
unf (0.1.4)
|
||||||
|
unf_ext
|
||||||
|
unf_ext (0.0.7.1)
|
||||||
|
|
||||||
|
PLATFORMS
|
||||||
|
ruby
|
||||||
|
|
||||||
|
DEPENDENCIES
|
||||||
|
bundler (~> 1.7)
|
||||||
|
codeclimate-test-reporter (~> 0.4)
|
||||||
|
coveralls (~> 0.8)
|
||||||
|
github_changelog_generator!
|
||||||
|
rake (~> 10.0)
|
||||||
|
rspec (~> 3.2)
|
||||||
|
rubocop (~> 0.31)
|
||||||
|
simplecov (~> 0.10)
|
||||||
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.
|
|
||||||
|
|
||||||
481
README.md
481
README.md
@@ -1,275 +1,208 @@
|
|||||||
[](http://badge.fury.io/rb/github_changelog_generator)
|
[](http://badge.fury.io/rb/github_changelog_generator)
|
||||||
[](https://gemnasium.com/skywinder/github-changelog-generator)
|
[](https://gemnasium.com/skywinder/github-changelog-generator)
|
||||||
[](https://travis-ci.org/skywinder/github-changelog-generator)
|
[](https://travis-ci.org/skywinder/github-changelog-generator)
|
||||||
[](https://ci.appveyor.com/project/olleolleolle/github-changelog-generator)
|
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
||||||
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
|
||||||
[](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 
|
|
||||||
==================
|
- [Installation](#installation)
|
||||||
|
- [Output example](#output-example)
|
||||||
- [Installation](#installation)
|
- [Usage](#usage)
|
||||||
- [Output example](#output-example)
|
- [Params](#params)
|
||||||
- [Usage](#usage)
|
- [GitHub token](#github-token)
|
||||||
- [Params](#params)
|
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
||||||
- [GitHub token](#github-token)
|
- [Alternatives](#alternatives)
|
||||||
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
- [Projects using this library](#projects-using-this-library)
|
||||||
- [Alternatives](#alternatives)
|
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
|
||||||
- [Projects using this library](#projects-using-this-library)
|
- [Contributing](#contributing)
|
||||||
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
|
- [License](#license)
|
||||||
- [Contributing](#contributing)
|
|
||||||
- [License](#license)
|
|
||||||
|
### Changelog generation has never been so easy:
|
||||||
|
|
||||||
### Changelog generation has never been so easy
|
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
|
||||||
|
|
||||||
**Fully automated changelog generation** - This gem generates a 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.
|
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 you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
|
>### *What’s the point of a change log?*
|
||||||
|
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
|
||||||
### *What’s the point of a change log?*
|
### *Why should I care?*
|
||||||
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
|
Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
||||||
### *Why should I care?*
|
|
||||||
Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
||||||
|
|
||||||
:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
|
## Installation
|
||||||
|
|
||||||
## Installation
|
[sudo] gem install github_changelog_generator
|
||||||
|
|
||||||
gem install github_changelog_generator
|
## Output example
|
||||||
|
|
||||||
See also Troubleshooting.
|
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
|
||||||
|
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
|
||||||
## Output example
|
|
||||||
|
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
||||||
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
|
|
||||||
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
|
- In general it looks like this:
|
||||||
|
|
||||||
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
||||||
|
>
|
||||||
- In general, it looks like this:
|
> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
||||||
|
>
|
||||||
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
> **Implemented enhancements:**
|
||||||
>
|
>
|
||||||
> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
||||||
>
|
>
|
||||||
> **Implemented enhancements:**
|
> **Fixed bugs:**
|
||||||
>
|
>
|
||||||
> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
||||||
>
|
>
|
||||||
> **Fixed bugs:**
|
> **Merged pull requests:**
|
||||||
>
|
>
|
||||||
> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
||||||
>
|
>
|
||||||
> **Merged pull requests:**
|
> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||||
>
|
|
||||||
> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
|
||||||
>
|
## Usage
|
||||||
> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
**It's really simple**:
|
||||||
|
|
||||||
|
- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
|
||||||
## Usage
|
|
||||||
**It's really simple!**
|
github_changelog_generator
|
||||||
|
|
||||||
- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
|
- or from anywhere:
|
||||||
|
- `github_changelog_generator -u github_username -p github_project`
|
||||||
github_changelog_generator
|
- `github_changelog_generator github_username/github_project`
|
||||||
|
|
||||||
- Or, run this from anywhere:
|
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||||
`github_changelog_generator -u github_username -p github_project`
|
|
||||||
`github_changelog_generator github_username/github_project`
|
### Params
|
||||||
|
Type `github_changelog_generator --help` for details.
|
||||||
- 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:
|
|
||||||
|
More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
||||||
github_changelog_generator --github-site="https://github.yoursite.com" \
|
|
||||||
--github-api="https://github.yoursite.com/api/v3/"
|
### GitHub token
|
||||||
|
|
||||||
This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
|
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
||||||
|
|
||||||
### Params
|
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
|
||||||
Type `github_changelog_generator --help` for details.
|
|
||||||
|
And:
|
||||||
For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
|
||||||
|
- Run with key `-t [your-16-digit-token]`
|
||||||
### Params File
|
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
||||||
In your project root, you can put a params file named `.github_changelog_generator` to override default params:
|
|
||||||
|
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
||||||
Example:
|
|
||||||
```
|
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
||||||
unreleased=false
|
|
||||||
future-release=5.0.0
|
So, if you got error like this:
|
||||||
since-tag=1.0.0
|
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
||||||
```
|
|
||||||
|
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||||
### GitHub token
|
|
||||||
|
|
||||||
GitHub only allows 50 unauthenticated requests per hour.
|
### Rake task
|
||||||
Therefore, it's recommended to run this script with authentication by using a **token**.
|
|
||||||
|
You love Rake? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
|
||||||
Here's how:
|
|
||||||
|
```ruby
|
||||||
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
|
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
||||||
- Either:
|
config.since_tag = '0.1.14'
|
||||||
- Run the script with `--token <your-40-digit-token>`; **OR**
|
config.future_release = '0.2.0'
|
||||||
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
|
end
|
||||||
|
```
|
||||||
You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
|
|
||||||
|
All command line options can be passed to the Rake task as `config` parameters. Since you're naming the Rake task yourself, you can create as many as you want, too.
|
||||||
export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
|
|
||||||
|
##Features and advantages of this project
|
||||||
So, if you get a message like this:
|
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
|
||||||
|
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
||||||
``` markdown
|
- **GitHub Enterprise support** via command line options! :factory:
|
||||||
API rate limit exceeded for github_username.
|
- Flexible format **customisation**:
|
||||||
See: https://developer.github.com/v3/#rate-limiting
|
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
|
||||||
```
|
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
|
||||||
|
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version :pushpin:
|
||||||
It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
|
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
|
||||||
|
- **Distinguish** issues **according labels**. :mag_right:
|
||||||
## Migrating from a manual changelog
|
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
|
||||||
|
- Bug fixes (by label `bug` in issue) :beetle:
|
||||||
Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
|
- Enhancements (by label `enhancement` in issue) :star2:
|
||||||
But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
|
- Issues (closed issues `w/o any labels`) :non-potable_water:
|
||||||
|
|
||||||
That's where `--base <your-manual-changelog.md>` comes in handy!
|
- You can manually set which labels should be included/excluded. :wrench:
|
||||||
This option lets append your old manual changelog to the end of the generated entries.
|
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
|
||||||
|
(*look `github_changelog_generator --help` for details)*
|
||||||
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
|
|
||||||
|
|
||||||
### Rake task
|
###Alternatives
|
||||||
|
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
|
||||||
You love `rake`? We do, too! So, we've made it even easier for you:
|
|
||||||
we've provided a `rake` task library for your changelog generation.
|
*If you know other projects - feel free to edit this Wiki page!*
|
||||||
|
|
||||||
Just put something like this in your `Rakefile`:
|
|
||||||
|
### Projects using this library
|
||||||
```ruby
|
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
||||||
require 'github_changelog_generator/task'
|
|
||||||
|
|
||||||
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
|
||||||
config.since_tag = '0.1.14'
|
|
||||||
config.future_release = '0.2.0'
|
|
||||||
end
|
|
||||||
```
|
|
||||||
|
|
||||||
All command line options can be passed to the `rake` task as `config` parameters. And since you're naming the `rake` task yourself, you can create as many as you want.
|
|
||||||
|
|
||||||
You can look for params names from the [parser source code (#setup_parser)](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on.
|
|
||||||
|
|
||||||
## Features and advantages of this project
|
|
||||||
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
|
|
||||||
- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
|
||||||
- **GitHub Enterprise support** via command line options! :factory:
|
|
||||||
- Flexible format **customization**:
|
|
||||||
- **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
|
|
||||||
- **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
|
|
||||||
- Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
|
|
||||||
- Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
|
|
||||||
- **Distinguish** issues **by labels**. :mag_right:
|
|
||||||
- Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
|
|
||||||
- Bug fixes (issues labeled `bug`) :beetle:
|
|
||||||
- Enhancements (issues labeled `enhancement`) :star2:
|
|
||||||
- Issues (closed issues with no labels) :non-potable_water:
|
|
||||||
|
|
||||||
- Manually include or exclude issues by labels :wrench:
|
|
||||||
- Customize lots more! Tweak the changelog to fit your preferences :tophat:
|
|
||||||
(*See `github_changelog_generator --help` for details)*
|
|
||||||
|
|
||||||
|
|
||||||
### Alternatives
|
|
||||||
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
|
|
||||||
|
|
||||||
*If you know other projects, feel free to edit this Wiki page!*
|
|
||||||
|
|
||||||
|
|
||||||
### Projects using this library
|
|
||||||
Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
|
|
||||||
|
|
||||||
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
|
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
|
||||||
|
|
||||||
*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
|
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
||||||
|
|
||||||
## Am I missing some essential feature?
|
## Am I missing some essential feature?
|
||||||
|
|
||||||
- **Nothing is impossible!**
|
- **Nothing is impossible!**
|
||||||
|
|
||||||
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
|
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||||
|
|
||||||
- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
|
- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
- ***I already use GitHub Releases. Why do I need this?***
|
- ***I already use GitHub Releases. Why do I need this?***
|
||||||
|
|
||||||
GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
|
GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
|
||||||
|
|
||||||
*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
||||||
|
|
||||||
I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
|
I'm not try to compare quality of auto-generated and manually generated logs.. but:
|
||||||
|
|
||||||
An auto-generated changelog really helps, even if you manually fill in the release notes!
|
The auto generated Changelog really helps even if you manually fill Releases notes!
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
When you find a closed bug, it is very useful to know which release fixed it.
|
When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
|
||||||
So that you can easily find the issue by \# in `CHANGELOG.md`.
|
|
||||||
|
- it's not so quite easy to find it in manually filled Releases notes.
|
||||||
- it's not quite as easy to find this in handwritten releases notes
|
- this file can also help you to build your Release note and not miss features in manually-filled list.
|
||||||
- a generated file saves you the trouble of remembering everything;
|
|
||||||
sometimes people forget to add things to a handwritten file
|
In the end:
|
||||||
|
|
||||||
Ultimately, I think GitHub Releases are ideal for end-users.
|
I think, that GitHub Releases is more for end-users.
|
||||||
Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
|
But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
|
||||||
Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
|
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
|
||||||
|
|
||||||
- ***I received a warning: "GitHub API rate limit exceed" What does this mean?***
|
- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
|
||||||
|
|
||||||
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
|
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
|
||||||
|
|
||||||
If you're seeing this warning, please do the following:
|
If you're seeing this warning:
|
||||||
|
|
||||||
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 anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
|
||||||
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. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
||||||
|
|
||||||
- ***My Ruby version is very old, can I use this?***
|
## Contributing
|
||||||
|
|
||||||
When your Ruby is old, and you don't want to upgrade, and you want to
|
1. Create an issue to discuss about your idea
|
||||||
control which libraries you use, you can use Bundler.
|
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
||||||
|
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
In a Gemfile, perhaps in a non-deployed `:development` group, add this
|
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||||
gem:
|
5. Push to the branch (`git push origin my-new-feature`)
|
||||||
|
6. Create a new Pull Request
|
||||||
```ruby
|
7. Profit! :white_check_mark:
|
||||||
group :development do
|
|
||||||
gem 'github_changelog_generator', require: false
|
## License
|
||||||
end
|
|
||||||
```
|
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
1. Create an issue and describe your idea
|
|
||||||
2. [Fork it](https://github.com/skywinder/github-changelog-generator/fork)
|
|
||||||
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
5. Publish the branch (`git push origin my-new-feature`)
|
|
||||||
6. Create a new Pull Request
|
|
||||||
7. Profit! :white_check_mark:
|
|
||||||
|
|
||||||
You can test your workflow with changelog generator with [the skywinder/changelog_test repo](https://github.com/skywinder/changelog_test/).
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
|
||||||
|
|||||||
15
Rakefile
15
Rakefile
@@ -1,20 +1,7 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require "bundler"
|
|
||||||
require "bundler/gem_tasks"
|
|
||||||
require "rubocop/rake_task"
|
require "rubocop/rake_task"
|
||||||
require "rspec/core/rake_task"
|
require "rspec/core/rake_task"
|
||||||
require "pathname"
|
|
||||||
require "fileutils"
|
|
||||||
require "overcommit"
|
|
||||||
|
|
||||||
RuboCop::RakeTask.new
|
RuboCop::RakeTask.new
|
||||||
RSpec::Core::RakeTask.new(:rspec)
|
RSpec::Core::RakeTask.new(:rspec)
|
||||||
|
|
||||||
desc "When releasing the gem, re-fetch latest cacert.pem from curl.haxx.se. Developer task."
|
task default: [:rubocop, :rspec]
|
||||||
task :update_ssl_ca_file do
|
|
||||||
`pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.haxx.se/ca/cacert.pem && popd`
|
|
||||||
end
|
|
||||||
|
|
||||||
task checks: %i[rubocop rspec]
|
|
||||||
task default: %i[rubocop rspec]
|
|
||||||
|
|||||||
58
appveyor.yml
58
appveyor.yml
@@ -1,58 +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"
|
|
||||||
|
|
||||||
init:
|
|
||||||
- git config --global core.autocrlf true
|
|
||||||
|
|
||||||
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
|
|
||||||
- provider: GitHubPullRequest
|
|
||||||
on_build_success: true
|
|
||||||
on_build_failure: true
|
|
||||||
on_build_status_changed: true
|
|
||||||
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
#! /usr/bin/env ruby
|
|
||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require_relative "../lib/github_changelog_generator"
|
|
||||||
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,4 +1,4 @@
|
|||||||
# frozen_string_literal: true
|
# coding: utf-8
|
||||||
|
|
||||||
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)
|
||||||
@@ -9,26 +9,24 @@ Gem::Specification.new do |spec|
|
|||||||
spec.version = GitHubChangelogGenerator::VERSION
|
spec.version = GitHubChangelogGenerator::VERSION
|
||||||
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.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("github_api", ["~> 0.12"])
|
||||||
spec.add_runtime_dependency "rainbow", ">= 2.2.1"
|
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
||||||
spec.add_runtime_dependency("octokit", ["~> 4.6"])
|
|
||||||
spec.add_runtime_dependency("faraday-http-cache")
|
# Development only
|
||||||
spec.add_runtime_dependency("activesupport")
|
spec.add_development_dependency "bundler", "~> 1.7"
|
||||||
spec.add_runtime_dependency("retriable", ["~> 3.0"])
|
spec.add_development_dependency "rake", "~> 10.0"
|
||||||
spec.add_runtime_dependency("multi_json")
|
|
||||||
end
|
end
|
||||||
|
|||||||
55
lib/CHANGELOG.md
Normal file
55
lib/CHANGELOG.md
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
# Change Log
|
||||||
|
|
||||||
|
## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/0.0.4...HEAD)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- BugFix [\#11](https://github.com/skywinder/changelog_test/issues/11)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Issue closed from commit from PR [\#14](https://github.com/skywinder/changelog_test/issues/14)
|
||||||
|
- Issue, closed by PR [\#12](https://github.com/skywinder/changelog_test/issues/12)
|
||||||
|
- Issue [\#10](https://github.com/skywinder/changelog_test/issues/10)
|
||||||
|
- Issue with some other label - Should be in closed issues [\#8](https://github.com/skywinder/changelog_test/issues/8)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
|
||||||
|
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
|
||||||
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Test issue, that should appear in 0.0.4 [\#3](https://github.com/skywinder/changelog_test/issues/3)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
|
||||||
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
|
||||||
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Here is a test hotfix should appear in v.0.0.2 [\#2](https://github.com/skywinder/changelog_test/pull/2) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
|
||||||
|
|
||||||
|
|
||||||
|
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||||
@@ -1,22 +1,15 @@
|
|||||||
#!/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 "active_support/core_ext/object/blank"
|
|
||||||
require "json"
|
require "json"
|
||||||
require "multi_json"
|
require "colorize"
|
||||||
require "benchmark"
|
require "benchmark"
|
||||||
|
|
||||||
require "github_changelog_generator/helper"
|
require_relative "github_changelog_generator/helper"
|
||||||
require "github_changelog_generator/options"
|
require_relative "github_changelog_generator/parser"
|
||||||
require "github_changelog_generator/parser"
|
require_relative "github_changelog_generator/generator/generator"
|
||||||
require "github_changelog_generator/parser_file"
|
require_relative "github_changelog_generator/version"
|
||||||
require "github_changelog_generator/generator/generator"
|
require_relative "github_changelog_generator/reader"
|
||||||
require "github_changelog_generator/version"
|
|
||||||
require "github_changelog_generator/reader"
|
|
||||||
|
|
||||||
# The main module, where placed all classes (now, at least)
|
# The main module, where placed all classes (now, at least)
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
@@ -34,10 +27,14 @@ module GitHubChangelogGenerator
|
|||||||
def run
|
def run
|
||||||
log = @generator.compound_changelog
|
log = @generator.compound_changelog
|
||||||
|
|
||||||
output_filename = @options[:output].to_s
|
output_filename = "#{@options[:output]}"
|
||||||
File.open(output_filename, "wb") { |file| file.write(log) }
|
File.open(output_filename, "w") { |file| file.write(log) }
|
||||||
puts "Done!"
|
puts "Done!"
|
||||||
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
if __FILE__ == $PROGRAM_NAME
|
||||||
|
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
209
lib/github_changelog_generator/fetcher.rb
Normal file
209
lib/github_changelog_generator/fetcher.rb
Normal file
@@ -0,0 +1,209 @@
|
|||||||
|
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 = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
|
||||||
|
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
|
||||||
|
obj = @github.issues.events.list user: @options[:user],
|
||||||
|
repo: @options[:project],
|
||||||
|
issue_number: issue["number"]
|
||||||
|
issue[:events] = obj.body
|
||||||
|
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,6 +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"
|
||||||
@@ -12,41 +10,40 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
class Generator
|
class Generator
|
||||||
attr_accessor :options, :filtered_tags, :github, :tag_section_mapping, :sorted_tags
|
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)
|
||||||
end
|
end
|
||||||
|
|
||||||
ENCAPSULATED_CHARACTERS = %w(< > * _ \( \) [ ] #)
|
# Encapsulate characters to make markdown look as expected.
|
||||||
|
|
||||||
# Encapsulate characters to make Markdown look as expected.
|
|
||||||
#
|
#
|
||||||
# @param [String] string
|
# @param [String] string
|
||||||
# @return [String] encapsulated input string
|
# @return [String] encapsulated input string
|
||||||
def encapsulate_string(string)
|
def encapsulate_string(string)
|
||||||
string = string.gsub('\\', '\\\\')
|
string.gsub! '\\', '\\\\'
|
||||||
|
|
||||||
ENCAPSULATED_CHARACTERS.each do |char|
|
encpas_chars = %w(< > * _ \( \) [ ] #)
|
||||||
string = string.gsub(char, "\\#{char}")
|
encpas_chars.each do |char|
|
||||||
|
string.gsub! char, "\\#{char}"
|
||||||
end
|
end
|
||||||
|
|
||||||
string
|
string
|
||||||
@@ -57,50 +54,40 @@ module GitHubChangelogGenerator
|
|||||||
# @param [Array] pull_requests List or PR's in new section
|
# @param [Array] pull_requests List or PR's in new section
|
||||||
# @param [Array] issues List of issues in new section
|
# @param [Array] issues List of issues in new section
|
||||||
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
||||||
# @param [Hash, nil] older_tag Older tag, used for the links. Could be nil for last tag.
|
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
|
||||||
# @return [String] Ready and parsed section
|
# @return [String] Ready and parsed section
|
||||||
def create_log_for_tag(pull_requests, issues, newer_tag, older_tag = nil)
|
def create_log_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
|
||||||
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
|
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
|
||||||
|
|
||||||
github_site = options[:github_site] || "https://github.com"
|
github_site = options[:github_site] || "https://github.com"
|
||||||
project_url = "#{github_site}/#{options[:user]}/#{options[:project]}"
|
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
||||||
|
|
||||||
# If the older tag is nil, go back in time from the latest tag and find
|
|
||||||
# the SHA for the first commit.
|
|
||||||
older_tag_name =
|
|
||||||
if older_tag.nil?
|
|
||||||
@fetcher.commits_before(newer_tag_time).last["sha"]
|
|
||||||
else
|
|
||||||
older_tag["name"]
|
|
||||||
end
|
|
||||||
|
|
||||||
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)
|
||||||
end
|
end
|
||||||
|
|
||||||
if options[:pulls] && options[:add_pr_wo_labels]
|
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
|
||||||
end
|
end
|
||||||
|
|
||||||
# Generate ready-to-paste log from list of issues and pull requests.
|
# Generate ready-to-paste log from list of issues.
|
||||||
#
|
#
|
||||||
# @param [Array] issues
|
# @param [Array] issues
|
||||||
# @param [Array] pull_requests
|
|
||||||
# @return [String] generated log for issues
|
# @return [String] generated log for issues
|
||||||
def issues_to_log(issues, pull_requests)
|
def issues_to_log(issues)
|
||||||
log = ""
|
log = ""
|
||||||
bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
|
bugs_a, enhancement_a, issues_a = parse_by_sections(issues)
|
||||||
|
|
||||||
log += generate_sub_section(enhancement_a, options[:enhancement_prefix])
|
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
||||||
log += generate_sub_section(bugs_a, options[:bug_prefix])
|
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
||||||
log += generate_sub_section(issues_a, options[:issue_prefix])
|
log += generate_sub_section(issues_a, @options[:issue_prefix])
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -108,47 +95,28 @@ module GitHubChangelogGenerator
|
|||||||
# (bugs, features, or just closed issues) by labels
|
# (bugs, features, or just closed issues) by labels
|
||||||
#
|
#
|
||||||
# @param [Array] issues
|
# @param [Array] issues
|
||||||
# @param [Array] pull_requests
|
|
||||||
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
|
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
|
||||||
def parse_by_sections(issues, pull_requests)
|
def parse_by_sections(issues)
|
||||||
issues_a = []
|
issues_a = []
|
||||||
enhancement_a = []
|
enhancement_a = []
|
||||||
bugs_a = []
|
bugs_a = []
|
||||||
|
|
||||||
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 = []
|
|
||||||
pull_requests.each do |pr|
|
|
||||||
pr["labels"].each do |label|
|
|
||||||
if options[:bug_labels].include?(label["name"])
|
|
||||||
bugs_a.push(pr)
|
|
||||||
added_pull_requests.push(pr)
|
|
||||||
next
|
|
||||||
end
|
|
||||||
if options[:enhancement_labels].include?(label["name"])
|
|
||||||
enhancement_a.push(pr)
|
|
||||||
added_pull_requests.push(pr)
|
|
||||||
next
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
added_pull_requests.each { |p| pull_requests.delete(p) }
|
|
||||||
|
|
||||||
[bugs_a, enhancement_a, issues_a]
|
[bugs_a, enhancement_a, issues_a]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,13 +1,9 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Generator
|
class Generator
|
||||||
MAX_THREAD_NUMBER = 25
|
|
||||||
|
|
||||||
# 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
|
||||||
|
|
||||||
@@ -16,36 +12,37 @@ 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.
|
||||||
@@ -53,10 +50,10 @@ module GitHubChangelogGenerator
|
|||||||
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
|
||||||
@@ -70,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]
|
||||||
|
rescue
|
||||||
# issue['actual_date'] = commit['author']['date']
|
puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
|
||||||
rescue StandardError
|
issue[:actual_date] = issue[:closed_at]
|
||||||
puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
|
|
||||||
issue["actual_date"] = issue["closed_at"]
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +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
|
||||||
@@ -7,35 +5,53 @@ 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 = "#{@options[:header]}\n\n"
|
||||||
log += options[:frontmatter] if options[:frontmatter]
|
|
||||||
log += "#{options[:header]}\n\n"
|
|
||||||
|
|
||||||
log += if options[:unreleased_only]
|
if @options[:unreleased_only]
|
||||||
generate_log_between_tags(filtered_tags[0], nil)
|
log += generate_log_between_tags(filtered_tags[0], nil)
|
||||||
else
|
else
|
||||||
generate_log_for_all_tags
|
log += generate_log_for_all_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
log += File.read(options[:base]) if File.file?(options[:base])
|
|
||||||
|
|
||||||
credit_line = "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
|
||||||
log.gsub!(credit_line, "") # Remove old credit lines
|
|
||||||
log += credit_line
|
|
||||||
|
|
||||||
|
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
|
||||||
|
fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
|
||||||
|
end
|
||||||
|
else
|
||||||
|
fail 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 Name 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
|
||||||
def generate_sub_section(issues, prefix)
|
def generate_sub_section(issues, prefix)
|
||||||
log = ""
|
log = ""
|
||||||
|
|
||||||
|
log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
|
||||||
|
|
||||||
if issues.any?
|
if issues.any?
|
||||||
log += "#{prefix}\n\n" unless options[:simple_list]
|
|
||||||
issues.each do |issue|
|
issues.each do |issue|
|
||||||
merge_string = get_string_for_issue(issue)
|
merge_string = get_string_for_issue(issue)
|
||||||
log += "- #{merge_string}\n"
|
log += "- #{merge_string}\n"
|
||||||
@@ -57,21 +73,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]
|
if @options[:release_url]
|
||||||
format(options[:release_url], newer_tag_link)
|
release_url = format(@options[:release_url], newer_tag_link)
|
||||||
else
|
else
|
||||||
"#{project_url}/tree/#{newer_tag_link}"
|
release_url = "#{project_url}/tree/#{newer_tag_link}"
|
||||||
end
|
end
|
||||||
log += if newer_tag_name.equal?(options[:unreleased_label])
|
if newer_tag_name.equal? @options[:unreleased_label]
|
||||||
"## [#{newer_tag_name}](#{release_url})\n\n"
|
log += "## [#{newer_tag_name}](#{release_url})\n\n"
|
||||||
else
|
else
|
||||||
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
|
log += "## [#{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
|
||||||
@@ -85,25 +101,26 @@ module GitHubChangelogGenerator
|
|||||||
def generate_log_between_tags(older_tag, newer_tag)
|
def generate_log_between_tags(older_tag, newer_tag)
|
||||||
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
|
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
|
||||||
|
|
||||||
|
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
|
||||||
|
|
||||||
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
|
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
|
||||||
# do not generate empty unreleased section
|
# do not generate empty unreleased section
|
||||||
return ""
|
return ""
|
||||||
end
|
end
|
||||||
|
|
||||||
create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag)
|
create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Filters issues and pull requests based on, respectively, `closed_at` and `merged_at`
|
# Apply all filters to issues and pull requests
|
||||||
# timestamp fields.
|
|
||||||
#
|
#
|
||||||
# @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, "merged_at", older_tag, newer_tag)
|
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, older_tag, newer_tag)
|
||||||
filtered_issues = delete_by_time(@issues, "closed_at", 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)
|
||||||
@@ -114,13 +131,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
|
||||||
@@ -128,10 +147,9 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
def generate_unreleased_section
|
def generate_unreleased_section
|
||||||
log = ""
|
log = ""
|
||||||
if options[:unreleased]
|
if @options[:unreleased]
|
||||||
start_tag = filtered_tags[0] || sorted_tags.last
|
unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
|
||||||
unreleased_log = generate_log_between_tags(start_tag, nil)
|
log += unreleased_log if unreleased_log
|
||||||
log += unreleased_log if unreleased_log
|
|
||||||
end
|
end
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
@@ -139,42 +157,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})"
|
||||||
if options[:issue_line_labels].present?
|
|
||||||
title_with_number = "#{title_with_number}#{line_labels_for(issue)}"
|
unless issue.pull_request.nil?
|
||||||
end
|
if @options[:author]
|
||||||
issue_line_with_user(title_with_number, issue)
|
if issue.user.nil?
|
||||||
end
|
title_with_number += " ({Null user})"
|
||||||
|
else
|
||||||
private
|
title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
|
||||||
|
end
|
||||||
def line_labels_for(issue)
|
end
|
||||||
labels = if options[:issue_line_labels] == ["ALL"]
|
|
||||||
issue["labels"]
|
|
||||||
else
|
|
||||||
issue["labels"].select { |label| options[:issue_line_labels].include?(label["name"]) }
|
|
||||||
end
|
|
||||||
labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
|
|
||||||
end
|
|
||||||
|
|
||||||
def issue_line_with_user(line, issue)
|
|
||||||
return line if !options[:author] || issue["pull_request"].nil?
|
|
||||||
|
|
||||||
user = issue["user"]
|
|
||||||
return "#{line} ({Null user})" unless user
|
|
||||||
|
|
||||||
if options[:usernames_as_github_logins]
|
|
||||||
"#{line} (@#{user['login']})"
|
|
||||||
else
|
|
||||||
"#{line} ([#{user['login']}](#{user['html_url']}))"
|
|
||||||
end
|
end
|
||||||
|
title_with_number
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,17 +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
|
||||||
@@ -33,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
|
||||||
@@ -54,39 +53,37 @@ 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
|
||||||
|
|
||||||
# Method filter issues, that belong only specified tag range
|
# Method filter issues, that belong only specified tag range
|
||||||
# @param [Array] issues issues to filter
|
# @param [Array] array of issues to filter
|
||||||
# @param [Symbol] hash_key key of date value default is :actual_date
|
# @param [Symbol] hash_key key of date value default is :actual_date
|
||||||
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
||||||
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
||||||
# @return [Array] filtered issues
|
# @return [Array] filtered issues
|
||||||
def delete_by_time(issues, hash_key = "actual_date", older_tag = nil, newer_tag = nil)
|
def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
|
||||||
# in case if not tags specified - return unchanged array
|
# in case if not tags specified - return unchanged array
|
||||||
return issues if older_tag.nil? && newer_tag.nil?
|
return array if older_tag.nil? && newer_tag.nil?
|
||||||
|
|
||||||
older_tag = ensure_older_tag(older_tag, newer_tag)
|
|
||||||
|
|
||||||
newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
|
newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
|
||||||
older_tag_time = older_tag && get_time_of_tag(older_tag)
|
older_tag_time = older_tag && get_time_of_tag(older_tag)
|
||||||
|
|
||||||
issues.select do |issue|
|
array.select do |req|
|
||||||
if issue[hash_key]
|
if req[hash_key]
|
||||||
time = Time.parse(issue[hash_key].to_s).utc
|
time = Time.parse(req[hash_key]).utc
|
||||||
|
|
||||||
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
||||||
|
|
||||||
tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
|
tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
|
||||||
|
|
||||||
tag_in_range = tag_in_range_old && tag_in_range_new
|
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
||||||
|
|
||||||
tag_in_range
|
tag_in_range
|
||||||
else
|
else
|
||||||
@@ -95,29 +92,21 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def ensure_older_tag(older_tag, newer_tag)
|
|
||||||
return older_tag if older_tag
|
|
||||||
idx = sorted_tags.index { |t| t["name"] == newer_tag["name"] }
|
|
||||||
# skip if we are already at the oldest element
|
|
||||||
return if idx == sorted_tags.size - 1
|
|
||||||
sorted_tags[idx - 1]
|
|
||||||
end
|
|
||||||
|
|
||||||
def tag_older_new_tag?(newer_tag_time, time)
|
def tag_older_new_tag?(newer_tag_time, time)
|
||||||
tag_in_range_new = if newer_tag_time.nil?
|
if newer_tag_time.nil?
|
||||||
true
|
tag_in_range_new = true
|
||||||
else
|
else
|
||||||
time <= newer_tag_time
|
tag_in_range_new = time <= newer_tag_time
|
||||||
end
|
end
|
||||||
tag_in_range_new
|
tag_in_range_new
|
||||||
end
|
end
|
||||||
|
|
||||||
def tag_newer_old_tag?(older_tag_time, t)
|
def tag_newer_old_tag?(older_tag_time, t)
|
||||||
tag_in_range_old = if older_tag_time.nil?
|
if older_tag_time.nil?
|
||||||
true
|
tag_in_range_old = true
|
||||||
else
|
else
|
||||||
t > older_tag_time
|
tag_in_range_old = t > older_tag_time
|
||||||
end
|
end
|
||||||
tag_in_range_old
|
tag_in_range_old
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -126,28 +115,27 @@ module GitHubChangelogGenerator
|
|||||||
# @return [Array] filtered array of issues
|
# @return [Array] filtered array of issues
|
||||||
def include_issues_by_labels(issues)
|
def include_issues_by_labels(issues)
|
||||||
filtered_issues = filter_by_include_labels(issues)
|
filtered_issues = filter_by_include_labels(issues)
|
||||||
filtered_issues = filter_wo_labels(filtered_issues)
|
filtered_issues |= filter_wo_labels(issues)
|
||||||
filtered_issues
|
filtered_issues
|
||||||
end
|
end
|
||||||
|
|
||||||
# @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
|
issues_wo_labels = issues.select do |issue|
|
||||||
else
|
!issue.labels.map(&:name).any?
|
||||||
issues.select { |issue| issue["labels"].map { |l| l["name"] }.any? }
|
end
|
||||||
|
return issues_wo_labels
|
||||||
end
|
end
|
||||||
|
[]
|
||||||
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
|
||||||
@@ -163,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
|
||||||
|
|
||||||
@@ -183,21 +171,19 @@ 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
|
|
||||||
if fetched_pr
|
|
||||||
pr["merged_at"] = fetched_pr["merged_at"]
|
|
||||||
closed_pull_requests.delete(fetched_pr)
|
|
||||||
end
|
end
|
||||||
|
pr[:merged_at] = fetched_pr[:merged_at]
|
||||||
|
closed_pull_requests.delete(fetched_pr)
|
||||||
end
|
end
|
||||||
|
|
||||||
pull_requests.reject! do |pr|
|
pull_requests.select! do |pr|
|
||||||
pr["merged_at"].nil?
|
!pr[:merged_at].nil?
|
||||||
end
|
end
|
||||||
|
|
||||||
pull_requests
|
pull_requests
|
||||||
|
|||||||
@@ -1,79 +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
|
|
||||||
fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
|
|
||||||
all_sorted_tags = sort_tags_by_date(all_tags)
|
|
||||||
|
|
||||||
@sorted_tags = filter_excluded_tags(all_sorted_tags)
|
|
||||||
@filtered_tags = get_filtered_tags(@sorted_tags)
|
|
||||||
|
|
||||||
# Because we need to properly create compare links, we need a sorted list
|
|
||||||
# of all filtered tags (including the excluded ones). We'll exclude those
|
|
||||||
# tags from section headers inside the mapping function.
|
|
||||||
section_tags = get_filtered_tags(all_sorted_tags)
|
|
||||||
|
|
||||||
@tag_section_mapping = build_tag_section_mapping(section_tags, @filtered_tags)
|
|
||||||
|
|
||||||
@filtered_tags
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# @param [Array] section_tags are the tags that need a subsection output
|
# Sort all tags by date
|
||||||
# @param [Array] filtered_tags is the list of filtered 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]
|
|
||||||
# rubocop:disable Style/For - for allows us to be more concise
|
|
||||||
def build_tag_section_mapping(section_tags, filtered_tags)
|
|
||||||
tag_mapping = {}
|
|
||||||
for i in 0..(section_tags.length - 1)
|
|
||||||
tag = section_tags[i]
|
|
||||||
|
|
||||||
# Don't create section header for the "since" tag
|
|
||||||
next if @since_tag && tag["name"] == @since_tag
|
|
||||||
|
|
||||||
# Don't create a section header for the first tag in between_tags
|
|
||||||
next if options[:between_tags] && tag == section_tags.last
|
|
||||||
|
|
||||||
# Don't create a section header for excluded tags
|
|
||||||
next unless filtered_tags.include?(tag)
|
|
||||||
|
|
||||||
older_tag = section_tags[i + 1]
|
|
||||||
tag_mapping[tag] = [older_tag, tag]
|
|
||||||
end
|
|
||||||
tag_mapping
|
|
||||||
end
|
|
||||||
# rubocop:enable Style/For
|
|
||||||
|
|
||||||
# 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?
|
fail 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
|
||||||
|
|
||||||
@@ -86,54 +41,37 @@ 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]
|
||||||
end
|
end
|
||||||
|
|
||||||
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
|
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
||||||
def detect_since_tag
|
|
||||||
@since_tag ||= options.fetch(:since_tag) { version_of_first_item }
|
|
||||||
end
|
|
||||||
|
|
||||||
def detect_due_tag
|
|
||||||
@due_tag ||= options.fetch(:due_tag, nil)
|
|
||||||
end
|
|
||||||
|
|
||||||
def version_of_first_item
|
|
||||||
return unless File.file?(options[:base].to_s)
|
|
||||||
|
|
||||||
sections = GitHubChangelogGenerator::Reader.new.read(options[:base])
|
|
||||||
sections.first["version"] if sections && sections.any?
|
|
||||||
end
|
|
||||||
|
|
||||||
# Return tags after filtering tags in lists provided by option: --exclude-tags
|
|
||||||
#
|
#
|
||||||
# @return [Array]
|
# @return [Array]
|
||||||
def get_filtered_tags(all_tags)
|
def get_filtered_tags(all_tags)
|
||||||
filtered_tags = filter_since_tag(all_tags)
|
filtered_tags = filter_since_tag(all_tags)
|
||||||
filter_due_tag(filtered_tags)
|
filtered_tags = filter_between_tags(filtered_tags)
|
||||||
|
filter_excluded_tags(filtered_tags)
|
||||||
end
|
end
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
|
||||||
# @return [Array] filtered tags according :since_tag option
|
|
||||||
def filter_since_tag(all_tags)
|
def filter_since_tag(all_tags)
|
||||||
filtered_tags = all_tags
|
filtered_tags = all_tags
|
||||||
tag = detect_since_tag
|
tag = @options[: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
|
if idx > 0
|
||||||
all_tags[0..idx]
|
filtered_tags = all_tags[0..idx - 1]
|
||||||
else
|
else
|
||||||
[]
|
filtered_tags = []
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
|
||||||
end
|
end
|
||||||
@@ -141,76 +79,30 @@ module GitHubChangelogGenerator
|
|||||||
filtered_tags
|
filtered_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
# @param [Array] all_tags all tags
|
def filter_between_tags(all_tags)
|
||||||
# @return [Array] filtered tags according :due_tag option
|
|
||||||
def filter_due_tag(all_tags)
|
|
||||||
filtered_tags = all_tags
|
filtered_tags = all_tags
|
||||||
tag = detect_due_tag
|
if @options[:between_tags]
|
||||||
if tag
|
@options[:between_tags].each do |tag|
|
||||||
if all_tags.any? && all_tags.map { |t| t["name"] }.include?(tag)
|
unless all_tags.map(&:name).include? tag
|
||||||
idx = all_tags.index { |t| t["name"] == tag }
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
|
||||||
filtered_tags = if idx > 0
|
end
|
||||||
all_tags[(idx + 1)..-1]
|
|
||||||
else
|
|
||||||
[]
|
|
||||||
end
|
|
||||||
else
|
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
|
|
||||||
end
|
end
|
||||||
|
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
|
|
||||||
# @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
|
|
||||||
def filter_excluded_tags(all_tags)
|
def filter_excluded_tags(all_tags)
|
||||||
if options[:exclude_tags]
|
filtered_tags = all_tags
|
||||||
apply_exclude_tags(all_tags)
|
if @options[:exclude_tags]
|
||||||
elsif options[:exclude_tags_regex]
|
@options[:exclude_tags].each do |tag|
|
||||||
apply_exclude_tags_regex(all_tags)
|
unless all_tags.map(&:name).include? tag
|
||||||
else
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
|
||||||
all_tags
|
end
|
||||||
end
|
end
|
||||||
end
|
filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def apply_exclude_tags(all_tags)
|
|
||||||
if options[:exclude_tags].is_a?(Regexp)
|
|
||||||
filter_tags_with_regex(all_tags, options[:exclude_tags], "--exclude-tags")
|
|
||||||
else
|
|
||||||
filter_exact_tags(all_tags)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def apply_exclude_tags_regex(all_tags)
|
|
||||||
regex = Regexp.new(options[:exclude_tags_regex])
|
|
||||||
filter_tags_with_regex(all_tags, regex, "--exclude-tags-regex")
|
|
||||||
end
|
|
||||||
|
|
||||||
def filter_tags_with_regex(all_tags, regex, regex_option_name)
|
|
||||||
warn_if_nonmatching_regex(all_tags, regex, regex_option_name)
|
|
||||||
all_tags.reject { |tag| regex =~ tag["name"] }
|
|
||||||
end
|
|
||||||
|
|
||||||
def filter_exact_tags(all_tags)
|
|
||||||
options[:exclude_tags].each do |tag|
|
|
||||||
warn_if_tag_not_found(all_tags, tag)
|
|
||||||
end
|
|
||||||
all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) }
|
|
||||||
end
|
|
||||||
|
|
||||||
def warn_if_nonmatching_regex(all_tags, regex, regex_option_name)
|
|
||||||
unless all_tags.map { |t| t["name"] }.any? { |t| regex =~ t }
|
|
||||||
Helper.log.warn "Warning: unable to reject any tag, using regex "\
|
|
||||||
"#{regex.inspect} in #{regex_option_name} option."
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def warn_if_tag_not_found(all_tags, tag)
|
|
||||||
unless all_tags.map { |t| t["name"] }.include?(tag)
|
|
||||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
|
|
||||||
end
|
end
|
||||||
|
filtered_tags
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,33 +1,33 @@
|
|||||||
# 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
|
||||||
def self.test?
|
def self.test?
|
||||||
defined? SpecHelper
|
defined?SpecHelper
|
||||||
end
|
end
|
||||||
|
|
||||||
# :nocov:
|
if test?
|
||||||
@log ||= if test?
|
@log ||= Logger.new(nil) # don't show any logs when running tests
|
||||||
Logger.new(nil) # don't show any logs when running tests
|
else
|
||||||
else
|
@log ||= Logger.new(STDOUT)
|
||||||
Logger.new(STDOUT)
|
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,396 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require "tmpdir"
|
|
||||||
require "retriable"
|
|
||||||
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 = 25
|
|
||||||
MAX_FORBIDDEN_RETRIES = 100
|
|
||||||
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 = {})
|
|
||||||
@options = options || {}
|
|
||||||
@user = @options[:user]
|
|
||||||
@project = @options[:project]
|
|
||||||
@since = @options[:since]
|
|
||||||
@http_cache = @options[:http_cache]
|
|
||||||
if @http_cache
|
|
||||||
@cache_file = @options.fetch(:cache_file) { File.join(Dir.tmpdir, "github-changelog-http-cache") }
|
|
||||||
@cache_log = @options.fetch(:cache_log) { File.join(Dir.tmpdir, "github-changelog-logger.log") }
|
|
||||||
init_cache
|
|
||||||
end
|
|
||||||
@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?
|
|
||||||
|
|
||||||
configure_octokit_ssl
|
|
||||||
|
|
||||||
@client = Octokit::Client.new(@github_options)
|
|
||||||
end
|
|
||||||
|
|
||||||
def configure_octokit_ssl
|
|
||||||
ca_file = @options[:ssl_ca_file] || ENV["SSL_CA_FILE"] || File.expand_path("../ssl_certs/cacert.pem", __FILE__)
|
|
||||||
Octokit.connection_options = { ssl: { ca_file: ca_file } }
|
|
||||||
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])
|
|
||||||
querystring_as_hash(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| stringify_keys_deep(h.to_hash) }
|
|
||||||
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| stringify_keys_deep(h.to_hash) }
|
|
||||||
|
|
||||||
# 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| stringify_keys_deep(h.to_hash) }
|
|
||||||
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| stringify_keys_deep(h.to_hash) }
|
|
||||||
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 = stringify_keys_deep(commit_data.to_hash)
|
|
||||||
|
|
||||||
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 = stringify_keys_deep(commit.to_hash)
|
|
||||||
commit
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetch all commits before certain point
|
|
||||||
#
|
|
||||||
# @return [String]
|
|
||||||
def commits_before(start_time)
|
|
||||||
commits = []
|
|
||||||
iterate_pages(@client, "commits_before", start_time.to_datetime.to_s) do |new_commits|
|
|
||||||
commits.concat(new_commits)
|
|
||||||
end
|
|
||||||
commits
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def stringify_keys_deep(indata)
|
|
||||||
case indata
|
|
||||||
when Array
|
|
||||||
indata.map do |value|
|
|
||||||
stringify_keys_deep(value)
|
|
||||||
end
|
|
||||||
when Hash
|
|
||||||
indata.each_with_object({}) do |(k, v), output|
|
|
||||||
output[k.to_s] = stringify_keys_deep(v)
|
|
||||||
end
|
|
||||||
else
|
|
||||||
indata
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
MovedPermanentlyError = Class.new(RuntimeError)
|
|
||||||
|
|
||||||
# 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')
|
|
||||||
#
|
|
||||||
# @yield [Sawyer::Resource] An OctoKit-provided response (which can be empty)
|
|
||||||
#
|
|
||||||
# @return [Integer] total number of pages
|
|
||||||
def iterate_pages(client, method, *args)
|
|
||||||
request_opts = extract_request_args(args)
|
|
||||||
args.push(@request_options.merge(request_opts))
|
|
||||||
|
|
||||||
number_of_pages = 1
|
|
||||||
|
|
||||||
check_github_response { client.send(method, user_project, *args) }
|
|
||||||
last_response = client.last_response
|
|
||||||
if last_response.status == 301
|
|
||||||
raise MovedPermanentlyError, last_response.data[:url]
|
|
||||||
end
|
|
||||||
|
|
||||||
yield(last_response.data)
|
|
||||||
|
|
||||||
until (next_one = last_response.rels[:next]).nil?
|
|
||||||
number_of_pages += 1
|
|
||||||
|
|
||||||
last_response = check_github_response { next_one.get }
|
|
||||||
yield(last_response.data)
|
|
||||||
end
|
|
||||||
|
|
||||||
number_of_pages
|
|
||||||
end
|
|
||||||
|
|
||||||
def extract_request_args(args)
|
|
||||||
if args.size == 1 && args.first.is_a?(Hash)
|
|
||||||
args.delete_at(0)
|
|
||||||
elsif args.size > 1 && args.last.is_a?(Hash)
|
|
||||||
args.delete_at(args.length - 1)
|
|
||||||
else
|
|
||||||
{}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# This is wrapper with rescue block
|
|
||||||
#
|
|
||||||
# @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
|
|
||||||
def check_github_response
|
|
||||||
Retriable.retriable(retry_options) do
|
|
||||||
yield
|
|
||||||
end
|
|
||||||
rescue MovedPermanentlyError => e
|
|
||||||
Helper.log.error("#{e.class}: #{e.message}")
|
|
||||||
sys_abort("The repository has moved, please update your configuration")
|
|
||||||
rescue Octokit::Forbidden => e
|
|
||||||
Helper.log.error("#{e.class}: #{e.message}")
|
|
||||||
sys_abort("Exceeded retry limit")
|
|
||||||
rescue Octokit::Unauthorized => e
|
|
||||||
Helper.log.error("#{e.class}: #{e.message}")
|
|
||||||
sys_abort("Error: wrong GitHub token")
|
|
||||||
end
|
|
||||||
|
|
||||||
# Exponential backoff
|
|
||||||
def retry_options
|
|
||||||
{
|
|
||||||
on: [Octokit::Forbidden],
|
|
||||||
tries: MAX_FORBIDDEN_RETRIES,
|
|
||||||
base_interval: sleep_base_interval,
|
|
||||||
multiplier: 1.0,
|
|
||||||
rand_factor: 0.0,
|
|
||||||
on_retry: retry_callback
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
def sleep_base_interval
|
|
||||||
1.0
|
|
||||||
end
|
|
||||||
|
|
||||||
def retry_callback
|
|
||||||
proc do |exception, try, elapsed_time, next_interval|
|
|
||||||
Helper.log.warn("RETRY - #{exception.class}: '#{exception.message}'")
|
|
||||||
Helper.log.warn("#{try} tries in #{elapsed_time} seconds and #{next_interval} seconds until the next try")
|
|
||||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
|
|
||||||
Helper.log.warn @client.rate_limit
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def sys_abort(msg)
|
|
||||||
abort(msg)
|
|
||||||
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
|
|
||||||
|
|
||||||
# Returns Hash of all querystring variables in given URI.
|
|
||||||
#
|
|
||||||
# @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 querystring_as_hash(uri)
|
|
||||||
Hash[URI.decode_www_form(URI(uri).query || "")]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,85 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require "delegate"
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
class Options < SimpleDelegator
|
|
||||||
UnsupportedOptionError = Class.new(ArgumentError)
|
|
||||||
|
|
||||||
KNOWN_OPTIONS = %i[
|
|
||||||
add_issues_wo_labels
|
|
||||||
add_pr_wo_labels
|
|
||||||
author
|
|
||||||
base
|
|
||||||
between_tags
|
|
||||||
bug_labels
|
|
||||||
bug_prefix
|
|
||||||
cache_file
|
|
||||||
cache_log
|
|
||||||
compare_link
|
|
||||||
date_format
|
|
||||||
due_tag
|
|
||||||
enhancement_labels
|
|
||||||
enhancement_prefix
|
|
||||||
exclude_labels
|
|
||||||
exclude_tags
|
|
||||||
exclude_tags_regex
|
|
||||||
filter_issues_by_milestone
|
|
||||||
frontmatter
|
|
||||||
future_release
|
|
||||||
git_remote
|
|
||||||
github_endpoint
|
|
||||||
github_site
|
|
||||||
header
|
|
||||||
http_cache
|
|
||||||
include_labels
|
|
||||||
issue_prefix
|
|
||||||
issue_line_labels
|
|
||||||
issues
|
|
||||||
max_issues
|
|
||||||
merge_prefix
|
|
||||||
output
|
|
||||||
project
|
|
||||||
pulls
|
|
||||||
release_branch
|
|
||||||
release_url
|
|
||||||
simple_list
|
|
||||||
since_tag
|
|
||||||
ssl_ca_file
|
|
||||||
token
|
|
||||||
unreleased
|
|
||||||
unreleased_label
|
|
||||||
unreleased_only
|
|
||||||
user
|
|
||||||
usernames_as_github_logins
|
|
||||||
verbose
|
|
||||||
]
|
|
||||||
|
|
||||||
def initialize(values)
|
|
||||||
super(values)
|
|
||||||
unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect)
|
|
||||||
end
|
|
||||||
|
|
||||||
def []=(key, val)
|
|
||||||
supported_option?(key) || raise(UnsupportedOptionError, key.inspect)
|
|
||||||
values[key] = val
|
|
||||||
end
|
|
||||||
|
|
||||||
def to_hash
|
|
||||||
values
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def values
|
|
||||||
__getobj__
|
|
||||||
end
|
|
||||||
|
|
||||||
def unsupported_options
|
|
||||||
values.keys - KNOWN_OPTIONS
|
|
||||||
end
|
|
||||||
|
|
||||||
def supported_option?(key)
|
|
||||||
KNOWN_OPTIONS.include?(key)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
218
lib/github_changelog_generator/parser.rb
Executable file → Normal file
218
lib/github_changelog_generator/parser.rb
Executable file → Normal file
@@ -1,6 +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"
|
||||||
@@ -9,44 +7,33 @@ module GitHubChangelogGenerator
|
|||||||
class Parser
|
class Parser
|
||||||
# parse options with optparse
|
# parse options with optparse
|
||||||
def self.parse_options
|
def self.parse_options
|
||||||
options = default_options
|
options = get_default_options
|
||||||
|
|
||||||
ParserFile.new(options).parse!
|
|
||||||
|
|
||||||
parser = setup_parser(options)
|
parser = setup_parser(options)
|
||||||
begin parser.parse!
|
|
||||||
rescue OptionParser::InvalidOption => e
|
parser.parse!
|
||||||
abort [e, parser].join("\n")
|
|
||||||
|
if options[:user].nil? || options[:project].nil?
|
||||||
|
detect_user_and_project(options, ARGV[0], ARGV[1])
|
||||||
end
|
end
|
||||||
|
|
||||||
fetch_user_and_project(options)
|
if !options[:user] || !options[:project]
|
||||||
|
puts parser.banner
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
|
||||||
abort(parser.banner) unless options[:user] && options[:project]
|
if options[:verbose]
|
||||||
|
Helper.log.info "Performing task with options:"
|
||||||
print_options(options)
|
pp options
|
||||||
|
puts ""
|
||||||
|
end
|
||||||
|
|
||||||
options
|
options
|
||||||
end
|
end
|
||||||
|
|
||||||
# If options set to verbose, print the parsed options.
|
|
||||||
#
|
|
||||||
# The GitHub `:token` key is censored in the output.
|
|
||||||
#
|
|
||||||
# @param options [Hash] The options to display
|
|
||||||
# @option options [Boolean] :verbose If false this method does nothing
|
|
||||||
def self.print_options(options)
|
|
||||||
if options[:verbose]
|
|
||||||
Helper.log.info "Performing task with options:"
|
|
||||||
options_to_display = options.clone
|
|
||||||
options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
|
|
||||||
pp options_to_display
|
|
||||||
puts ""
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# setup parsing options
|
# setup parsing options
|
||||||
def self.setup_parser(options)
|
def self.setup_parser(options)
|
||||||
parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
|
parser = OptionParser.new do |opts|
|
||||||
opts.banner = "Usage: github_changelog_generator [options]"
|
opts.banner = "Usage: github_changelog_generator [options]"
|
||||||
opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
|
opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
|
||||||
options[:user] = last
|
options[:user] = last
|
||||||
@@ -63,10 +50,7 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
||||||
options[:output] = last
|
options[:output] = last
|
||||||
end
|
end
|
||||||
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
|
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
|
||||||
options[:base] = last
|
|
||||||
end
|
|
||||||
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
|
|
||||||
options[:bug_prefix] = v
|
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|
|
||||||
@@ -78,9 +62,6 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
|
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
|
||||||
options[:header] = v
|
options[:header] = v
|
||||||
end
|
end
|
||||||
opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
|
|
||||||
options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
|
|
||||||
end
|
|
||||||
opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
|
opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
|
||||||
options[:merge_prefix] = v
|
options[:merge_prefix] = v
|
||||||
end
|
end
|
||||||
@@ -102,16 +83,13 @@ 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
|
||||||
opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
|
opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
|
||||||
options[:unreleased] = v
|
options[:unreleased] = v
|
||||||
end
|
end
|
||||||
opts.on("--unreleased-label [label]", "Setup custom label for unreleased closed issues section. Default is \"**Unreleased:**\"") do |v|
|
opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v|
|
||||||
options[:unreleased_label] = v
|
options[:unreleased_label] = v
|
||||||
end
|
end
|
||||||
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
|
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
|
||||||
@@ -129,21 +107,15 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
|
opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
|
||||||
options[:enhancement_labels] = list
|
options[:enhancement_labels] = list
|
||||||
end
|
end
|
||||||
opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
|
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
|
||||||
options[:issue_line_labels] = list
|
options[:between_tags] = list
|
||||||
end
|
end
|
||||||
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
|
||||||
opts.on("--due-tag x", "Change log will end before specified tag") do |v|
|
|
||||||
options[:due_tag] = v
|
|
||||||
end
|
|
||||||
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
||||||
options[:max_issues] = max
|
options[:max_issues] = max
|
||||||
end
|
end
|
||||||
@@ -162,21 +134,6 @@ module GitHubChangelogGenerator
|
|||||||
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
|
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
|
||||||
options[:future_release] = future_release
|
options[:future_release] = future_release
|
||||||
end
|
end
|
||||||
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
|
|
||||||
options[:release_branch] = release_branch
|
|
||||||
end
|
|
||||||
opts.on("--[no-]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 github-changelog-http-cache in a temporary directory.") do |cache_file|
|
|
||||||
options[:cache_file] = cache_file
|
|
||||||
end
|
|
||||||
opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log|
|
|
||||||
options[:cache_log] = cache_log
|
|
||||||
end
|
|
||||||
opts.on("--ssl-ca-file [PATH]", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
|
|
||||||
options[:ssl_ca_file] = ssl_ca_file
|
|
||||||
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
|
||||||
@@ -192,12 +149,13 @@ module GitHubChangelogGenerator
|
|||||||
parser
|
parser
|
||||||
end
|
end
|
||||||
|
|
||||||
# @return [Hash] Default options
|
# just get default options
|
||||||
def self.default_options
|
def self.get_default_options
|
||||||
Options.new(
|
options = {
|
||||||
|
tag1: nil,
|
||||||
|
tag2: nil,
|
||||||
date_format: "%Y-%m-%d",
|
date_format: "%Y-%m-%d",
|
||||||
output: "CHANGELOG.md",
|
output: "CHANGELOG.md",
|
||||||
base: "HISTORY.md",
|
|
||||||
issues: true,
|
issues: true,
|
||||||
add_issues_wo_labels: true,
|
add_issues_wo_labels: true,
|
||||||
add_pr_wo_labels: true,
|
add_pr_wo_labels: true,
|
||||||
@@ -207,82 +165,58 @@ module GitHubChangelogGenerator
|
|||||||
unreleased: true,
|
unreleased: true,
|
||||||
unreleased_label: "Unreleased",
|
unreleased_label: "Unreleased",
|
||||||
compare_link: true,
|
compare_link: true,
|
||||||
enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
|
enhancement_labels: %w(enhancement Enhancement),
|
||||||
bug_labels: ["bug", "Bug", "Type: Bug"],
|
bug_labels: %w(bug Bug),
|
||||||
exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
|
exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
|
||||||
issue_line_labels: [],
|
|
||||||
max_issues: nil,
|
max_issues: nil,
|
||||||
simple_list: false,
|
simple_list: false,
|
||||||
ssl_ca_file: nil,
|
|
||||||
verbose: true,
|
verbose: true,
|
||||||
header: "# Change Log",
|
header: "# Change Log",
|
||||||
merge_prefix: "**Merged pull requests:**",
|
merge_prefix: "**Merged pull requests:**",
|
||||||
issue_prefix: "**Closed issues:**",
|
issue_prefix: "**Closed issues:**",
|
||||||
bug_prefix: "**Fixed bugs:**",
|
bug_prefix: "**Fixed bugs:**",
|
||||||
enhancement_prefix: "**Implemented enhancements:**",
|
enhancement_prefix: "**Implemented enhancements:**",
|
||||||
git_remote: "origin",
|
git_remote: "origin"
|
||||||
http_cache: true
|
}
|
||||||
)
|
|
||||||
|
options
|
||||||
end
|
end
|
||||||
|
|
||||||
# If `:user` or `:project` not set in options, try setting them
|
# Detects user and project from git
|
||||||
# Valid unnamed parameters:
|
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
|
||||||
# 1) in 1 param: repo_name/project
|
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
|
||||||
# 2) in 2 params: repo name project
|
if !options[:user] || !options[:project]
|
||||||
def self.fetch_user_and_project(options)
|
|
||||||
if options[:user].nil? || options[:project].nil?
|
|
||||||
user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
|
|
||||||
options[:user] ||= user
|
|
||||||
options[:project] ||= project
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
|
|
||||||
# @param [String] arg0 first argument in cli
|
|
||||||
# @param [String] arg1 second argument in cli
|
|
||||||
# @return [Array<String>] user and project, or nil if unsuccessful
|
|
||||||
def self.user_and_project_from_git(options, arg0 = nil, arg1 = nil)
|
|
||||||
user, project = user_project_from_option(arg0, arg1, options[:github_site])
|
|
||||||
unless user && project
|
|
||||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||||
user = "skywinder"
|
options[:user] = "skywinder"
|
||||||
project = "changelog_test"
|
options[:project] = "changelog_test"
|
||||||
else
|
else
|
||||||
remote = `git config --get remote.#{options[:git_remote]}.url`
|
remote = `git config --get remote.#{options[:git_remote]}.url`
|
||||||
user, project = user_project_from_remote(remote)
|
options[:user], options[:project] = user_project_from_remote(remote)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
[user, project]
|
|
||||||
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
|
def self.user_project_from_option(arg0, arg1, github_site = nil)
|
||||||
# @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)
|
|
||||||
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
|
||||||
param = match[2].nil?
|
param = match[2].nil?
|
||||||
rescue StandardError
|
rescue
|
||||||
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
|
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
|
||||||
return
|
exit
|
||||||
end
|
end
|
||||||
if param
|
if param
|
||||||
return
|
exit
|
||||||
else
|
else
|
||||||
user = match[1]
|
user = match[1]
|
||||||
project = match[2]
|
project = match[2]
|
||||||
@@ -291,43 +225,43 @@ 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]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
if __FILE__ == $PROGRAM_NAME
|
||||||
|
remote = "invalid reference to project"
|
||||||
|
p user_project_from_option(ARGV[0], ARGV[1], remote)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,105 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require "pathname"
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
ParserError = Class.new(StandardError)
|
|
||||||
|
|
||||||
# ParserFile is a configuration file reader which sets options in the
|
|
||||||
# given Hash.
|
|
||||||
#
|
|
||||||
# In your project's root, you can put a file named
|
|
||||||
# <tt>.github_changelog_generator</tt> to override defaults.
|
|
||||||
#
|
|
||||||
# Example:
|
|
||||||
# header_label=# My Super Changelog
|
|
||||||
# ; Comments are allowed
|
|
||||||
# future-release=5.0.0
|
|
||||||
# # Ruby-style comments, too
|
|
||||||
# since-tag=1.0.0
|
|
||||||
#
|
|
||||||
# The configuration format is <tt>some-key=value</tt> or <tt>some_key=value</tt>.
|
|
||||||
#
|
|
||||||
class ParserFile
|
|
||||||
# @param options [Hash] options to be configured from file contents
|
|
||||||
# @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
|
|
||||||
def initialize(options, file = open_settings_file)
|
|
||||||
@options = options
|
|
||||||
@file = file
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sets options using configuration file content
|
|
||||||
def parse!
|
|
||||||
return unless @file
|
|
||||||
@file.each_with_index { |line, i| parse_line!(line, i + 1) }
|
|
||||||
@file.close
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
FILENAME = ".github_changelog_generator"
|
|
||||||
|
|
||||||
def open_settings_file
|
|
||||||
path = Pathname(File.expand_path(FILENAME))
|
|
||||||
File.open(path) if path.exist?
|
|
||||||
end
|
|
||||||
|
|
||||||
def parse_line!(line, line_number)
|
|
||||||
return if non_configuration_line?(line)
|
|
||||||
option_name, value = extract_pair(line)
|
|
||||||
@options[option_key_for(option_name)] = convert_value(value, option_name)
|
|
||||||
rescue StandardError
|
|
||||||
raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns true if the line starts with a pound sign or a semi-colon.
|
|
||||||
def non_configuration_line?(line)
|
|
||||||
line =~ /^[\#;]/ || line =~ /^[\s]+$/
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns a the option name as a symbol and its string value sans newlines.
|
|
||||||
#
|
|
||||||
# @param line [String] unparsed line from config file
|
|
||||||
# @return [Array<Symbol, String>]
|
|
||||||
def extract_pair(line)
|
|
||||||
key, value = line.split("=", 2)
|
|
||||||
[key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
|
|
||||||
end
|
|
||||||
|
|
||||||
KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels bug_labels
|
|
||||||
enhancement_labels issue_line_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
|
|
||||||
@@ -1,5 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Author:: Enrico Stahn <mail@enricostahn.com>
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
#
|
#
|
||||||
@@ -55,28 +53,31 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
@heading_structures.each do |regexp|
|
@heading_structures.each do |regexp|
|
||||||
matches = Regexp.new(regexp).match(heading)
|
matches = Regexp.new(regexp).match(heading)
|
||||||
if matches
|
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
|
||||||
captures.merge!(Hash[matches.names.zip(matches.captures)])
|
|
||||||
break
|
# Try Regular Expressions until you find one that delivers results
|
||||||
end
|
break unless matches.nil?
|
||||||
end
|
end
|
||||||
|
|
||||||
captures
|
captures
|
||||||
end
|
end
|
||||||
|
|
||||||
# Parse the given ChangeLog data into a list of Hashes
|
# Parse the given ChangeLog data into a Hash
|
||||||
#
|
#
|
||||||
# @param [String] data File data from the ChangeLog.md
|
# @param [String] data File data from the ChangeLog.md
|
||||||
# @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
||||||
def parse(data)
|
def parse(data)
|
||||||
sections = data.split(/^## .+?$/)
|
sections = data.split(/^## .+?$/)
|
||||||
headings = data.scan(/^## .+?$/)
|
headings = data.scan(/^## .+?$/)
|
||||||
|
changelog = []
|
||||||
|
|
||||||
headings.each_with_index.map do |heading, index|
|
headings.each_with_index do |heading, index|
|
||||||
section = parse_heading(heading)
|
captures = parse_heading(heading)
|
||||||
section["content"] = sections.at(index + 1)
|
captures["content"] = sections.at(index + 1)
|
||||||
section
|
changelog.push captures
|
||||||
end
|
end
|
||||||
|
|
||||||
|
changelog
|
||||||
end
|
end
|
||||||
|
|
||||||
def read(file_path)
|
def read(file_path)
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
require "rake"
|
require "rake"
|
||||||
require "rake/tasklib"
|
require "rake/tasklib"
|
||||||
require "github_changelog_generator"
|
require "github_changelog_generator"
|
||||||
@@ -8,7 +6,7 @@ module GitHubChangelogGenerator
|
|||||||
class RakeTask < ::Rake::TaskLib
|
class RakeTask < ::Rake::TaskLib
|
||||||
include ::Rake::DSL if defined?(::Rake::DSL)
|
include ::Rake::DSL if defined?(::Rake::DSL)
|
||||||
|
|
||||||
OPTIONS = %w[ user project token date_format output
|
OPTIONS = %w( user project token date_format output
|
||||||
bug_prefix enhancement_prefix issue_prefix
|
bug_prefix enhancement_prefix issue_prefix
|
||||||
header merge_prefix issues
|
header merge_prefix issues
|
||||||
add_issues_wo_labels add_pr_wo_labels
|
add_issues_wo_labels add_pr_wo_labels
|
||||||
@@ -16,10 +14,9 @@ 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 verbose )
|
||||||
base ]
|
|
||||||
|
|
||||||
OPTIONS.each do |o|
|
OPTIONS.each do |o|
|
||||||
attr_accessor o.to_sym
|
attr_accessor o.to_sym
|
||||||
@@ -39,27 +36,29 @@ module GitHubChangelogGenerator
|
|||||||
def define(args, &task_block)
|
def define(args, &task_block)
|
||||||
desc "Generate a Change log from GitHub"
|
desc "Generate a Change log from GitHub"
|
||||||
|
|
||||||
yield(*[self, args].slice(0, task_block.arity)) if task_block
|
task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
|
||||||
|
|
||||||
# clear any (auto-)pre-existing task
|
# clear any (auto-)pre-existing task
|
||||||
Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
|
Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
|
||||||
|
|
||||||
task @name do
|
task @name do
|
||||||
# mimick parse_options
|
# mimick parse_options
|
||||||
options = Parser.default_options
|
options = Parser.get_default_options
|
||||||
|
|
||||||
Parser.fetch_user_and_project(options)
|
if options[:user].nil? || options[:project].nil?
|
||||||
|
Parser.detect_user_and_project(options)
|
||||||
|
end
|
||||||
|
|
||||||
OPTIONS.each do |o|
|
OPTIONS.each do |o|
|
||||||
v = instance_variable_get("@#{o}")
|
v = instance_variable_get("@#{o}")
|
||||||
options[o.to_sym] = v unless v.nil?
|
options[o.to_sym] = v if v
|
||||||
end
|
end
|
||||||
|
|
||||||
generator = Generator.new options
|
generator = Generator.new options
|
||||||
|
|
||||||
log = generator.compound_changelog
|
log = generator.compound_changelog
|
||||||
|
|
||||||
output_filename = (options[:output]).to_s
|
output_filename = "#{options[:output]}"
|
||||||
File.open(output_filename, "w") { |file| file.write(log) }
|
File.open(output_filename, "w") { |file| file.write(log) }
|
||||||
puts "Done!"
|
puts "Done!"
|
||||||
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
VERSION = "1.15.0-alpha"
|
VERSION = "1.7.0"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,294 +0,0 @@
|
|||||||
.\" generated with Ronn/v0.7.3
|
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
||||||
.
|
|
||||||
.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
|
|
||||||
.
|
|
||||||
.SH "NAME"
|
|
||||||
\fBgit\-generate\-changelog\fR \- Generate changelog from github
|
|
||||||
.
|
|
||||||
.SH "SYNOPSIS"
|
|
||||||
\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
|
|
||||||
.
|
|
||||||
.SH "DESCRIPTION"
|
|
||||||
Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
|
|
||||||
.
|
|
||||||
.SH "OPTIONS"
|
|
||||||
\-u, \-\-user [USER]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Username of the owner of target GitHub repo
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-p, \-\-project [PROJECT]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Name of project on GitHub
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-t, \-\-token [TOKEN]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-f, \-\-date\-format [FORMAT]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Date format\. Default is %Y\-%m\-%d
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-o, \-\-output [NAME]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Output file\. Default is CHANGELOG\.md
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-b, \-\-base [NAME]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Optional base file to append generated changes to\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-bugs\-label [LABEL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-enhancement\-label [LABEL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-issues\-label [LABEL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-header\-label [LABEL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Setup custom header label\. Default is "# Change Log"
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-front\-matter [JSON]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-pr\-label [LABEL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]issues
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Include closed issues in changelog\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]issues\-wo\-labels
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Include closed issues without labels in changelog\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]pr\-wo\-labels
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Include pull requests without labels in changelog\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]pull\-requests
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Include pull\-requests in changelog\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]filter\-by\-milestone
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Use milestone to detect when issue was resolved\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]author
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Add author of pull\-request in the end\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-usernames\-as\-github\-logins
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Use GitHub tags instead of Markdown links for the author of an issue or pull\-request\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-unreleased\-only
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Generate log from unreleased closed issues only\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]unreleased
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Add to log unreleased closed issues\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-unreleased\-label [label]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Setup custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]compare\-link
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Include compare link (Full Changelog) between older version and newer version\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-include\-labels x,y,z
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Only issues with the specified labels will be included in the changelog\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-exclude\-labels x,y,z
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-bug\-labels x,y,z
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-enhancement\-labels x,y,z
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-between\-tags x,y,z
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Change log will be filled only between specified tags
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-exclude\-tags x,y,z
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Change log will exclude specified tags
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-exclude\-tags\-regex [REGEX]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-since\-tag x
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Change log will start after specified tag
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-due\-tag x
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Change log will end before specified tag
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-max\-issues [NUMBER]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Max number of issues to fetch from GitHub\. Default is unlimited
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-release\-url [URL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
The URL to point to for release links, in printf format (with the tag as variable)\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-github\-site [URL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
The Enterprise Github site on which your project is hosted\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-github\-api [URL]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
The enterprise endpoint to use for your Github API\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-simple\-list
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Create simple list from issues and pull requests\. Default is false\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-future\-release [RELEASE\-VERSION]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Put the unreleased changes in the specified release number\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-release\-branch [RELEASE\-BRANCH]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Limit pull requests to the release branch, such as master or release
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-http\-cache
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Use HTTP Cache to cache Github API requests (useful for large repos) Default is true\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]cache\-file [CACHE\-FILE]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Filename to use for cache\. Default is github\-changelog\-http\-cache in a temporary directory\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-cache\-log [CACHE\-LOG]
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-\-[no\-]verbose
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Run verbosely\. Default is true
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-v, \-\-version
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Print version number
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
\-h, \-\-help
|
|
||||||
.
|
|
||||||
.P
|
|
||||||
Displays Help
|
|
||||||
.
|
|
||||||
.SH "EXAMPLES"
|
|
||||||
.
|
|
||||||
.SH "AUTHOR"
|
|
||||||
Written by Petr Korolev sky4winder@gmail\.com
|
|
||||||
.
|
|
||||||
.SH "REPORTING BUGS"
|
|
||||||
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
|
|
||||||
.
|
|
||||||
.SH "SEE ALSO"
|
|
||||||
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>
|
|
||||||
@@ -1,286 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
|
||||||
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
|
||||||
<title>git-generate-changelog(1) - Generate changelog from github</title>
|
|
||||||
<style type='text/css' media='all'>
|
|
||||||
/* style: man */
|
|
||||||
body#manpage {margin:0}
|
|
||||||
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
||||||
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
||||||
.mp h2 {margin:10px 0 0 0}
|
|
||||||
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
||||||
.mp h3 {margin:0 0 0 4ex}
|
|
||||||
.mp dt {margin:0;clear:left}
|
|
||||||
.mp dt.flush {float:left;width:8ex}
|
|
||||||
.mp dd {margin:0 0 0 9ex}
|
|
||||||
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
||||||
.mp pre {margin-bottom:20px}
|
|
||||||
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
||||||
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
||||||
.mp img {display:block;margin:auto}
|
|
||||||
.mp h1.man-title {display:none}
|
|
||||||
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
||||||
.mp h2 {font-size:16px;line-height:1.25}
|
|
||||||
.mp h1 {font-size:20px;line-height:2}
|
|
||||||
.mp {text-align:justify;background:#fff}
|
|
||||||
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
||||||
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
||||||
.mp u {text-decoration:underline}
|
|
||||||
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
||||||
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
||||||
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
||||||
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
||||||
.mp pre {padding:0 4ex}
|
|
||||||
.mp pre code {font-weight:normal;color:#434241}
|
|
||||||
.mp h2+pre,h3+pre {padding-left:0}
|
|
||||||
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
||||||
ol.man-decor {width:100%}
|
|
||||||
ol.man-decor li.tl {text-align:left}
|
|
||||||
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
||||||
ol.man-decor li.tr {text-align:right;float:right}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<!--
|
|
||||||
The following styles are deprecated and will be removed at some point:
|
|
||||||
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
||||||
|
|
||||||
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
||||||
.man-navigation should be used instead.
|
|
||||||
-->
|
|
||||||
<body id='manpage'>
|
|
||||||
<div class='mp' id='man'>
|
|
||||||
|
|
||||||
<div class='man-navigation' style='display:none'>
|
|
||||||
<a href="#NAME">NAME</a>
|
|
||||||
<a href="#SYNOPSIS">SYNOPSIS</a>
|
|
||||||
<a href="#DESCRIPTION">DESCRIPTION</a>
|
|
||||||
<a href="#OPTIONS">OPTIONS</a>
|
|
||||||
<a href="#EXAMPLES">EXAMPLES</a>
|
|
||||||
<a href="#AUTHOR">AUTHOR</a>
|
|
||||||
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
|
|
||||||
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<ol class='man-decor man-head man head'>
|
|
||||||
<li class='tl'>git-generate-changelog(1)</li>
|
|
||||||
<li class='tc'></li>
|
|
||||||
<li class='tr'>git-generate-changelog(1)</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
<h2 id="NAME">NAME</h2>
|
|
||||||
<p class="man-name">
|
|
||||||
<code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
||||||
|
|
||||||
<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
|
|
||||||
|
|
||||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
||||||
|
|
||||||
<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
|
|
||||||
|
|
||||||
<h2 id="OPTIONS">OPTIONS</h2>
|
|
||||||
|
|
||||||
<p> -u, --user [USER]</p>
|
|
||||||
|
|
||||||
<p> Username of the owner of target GitHub repo</p>
|
|
||||||
|
|
||||||
<p> -p, --project [PROJECT]</p>
|
|
||||||
|
|
||||||
<p> Name of project on GitHub</p>
|
|
||||||
|
|
||||||
<p> -t, --token [TOKEN]</p>
|
|
||||||
|
|
||||||
<p> To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
|
|
||||||
|
|
||||||
<p> -f, --date-format [FORMAT]</p>
|
|
||||||
|
|
||||||
<p> Date format. Default is %Y-%m-%d</p>
|
|
||||||
|
|
||||||
<p> -o, --output [NAME]</p>
|
|
||||||
|
|
||||||
<p> Output file. Default is CHANGELOG.md</p>
|
|
||||||
|
|
||||||
<p> -b, --base [NAME]</p>
|
|
||||||
|
|
||||||
<p> Optional base file to append generated changes to.</p>
|
|
||||||
|
|
||||||
<p> --bugs-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
|
|
||||||
|
|
||||||
<p> --enhancement-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
|
|
||||||
|
|
||||||
<p> --issues-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
|
|
||||||
|
|
||||||
<p> --header-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom header label. Default is "# Change Log"</p>
|
|
||||||
|
|
||||||
<p> --front-matter [JSON]</p>
|
|
||||||
|
|
||||||
<p> Add YAML front matter. Formatted as JSON because it's easier to add on the command line</p>
|
|
||||||
|
|
||||||
<p> --pr-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
|
|
||||||
|
|
||||||
<p> --[no-]issues</p>
|
|
||||||
|
|
||||||
<p> Include closed issues in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]issues-wo-labels</p>
|
|
||||||
|
|
||||||
<p> Include closed issues without labels in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]pr-wo-labels</p>
|
|
||||||
|
|
||||||
<p> Include pull requests without labels in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]pull-requests</p>
|
|
||||||
|
|
||||||
<p> Include pull-requests in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]filter-by-milestone</p>
|
|
||||||
|
|
||||||
<p> Use milestone to detect when issue was resolved. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]author</p>
|
|
||||||
|
|
||||||
<p> Add author of pull-request in the end. Default is true</p>
|
|
||||||
|
|
||||||
<p> --usernames-as-github-logins</p>
|
|
||||||
|
|
||||||
<p> Use GitHub tags instead of Markdown links for the author of an issue or pull-request.</p>
|
|
||||||
|
|
||||||
<p> --unreleased-only</p>
|
|
||||||
|
|
||||||
<p> Generate log from unreleased closed issues only.</p>
|
|
||||||
|
|
||||||
<p> --[no-]unreleased</p>
|
|
||||||
|
|
||||||
<p> Add to log unreleased closed issues. Default is true</p>
|
|
||||||
|
|
||||||
<p> --unreleased-label [label]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>"</p>
|
|
||||||
|
|
||||||
<p> --[no-]compare-link</p>
|
|
||||||
|
|
||||||
<p> Include compare link (Full Changelog) between older version and newer version. Default is true</p>
|
|
||||||
|
|
||||||
<p> --include-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Only issues with the specified labels will be included in the changelog.</p>
|
|
||||||
|
|
||||||
<p> --exclude-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
|
|
||||||
|
|
||||||
<p> --bug-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
|
|
||||||
|
|
||||||
<p> --enhancement-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
|
|
||||||
|
|
||||||
<p> --exclude-tags x,y,z</p>
|
|
||||||
|
|
||||||
<p> Change log will exclude specified tags</p>
|
|
||||||
|
|
||||||
<p> --exclude-tags-regex [REGEX]</p>
|
|
||||||
|
|
||||||
<p> Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}"</p>
|
|
||||||
|
|
||||||
<p> --since-tag x</p>
|
|
||||||
|
|
||||||
<p> Change log will start after specified tag</p>
|
|
||||||
|
|
||||||
<p> --due-tag x</p>
|
|
||||||
|
|
||||||
<p> Change log will end before specified tag</p>
|
|
||||||
|
|
||||||
<p> --max-issues [NUMBER]</p>
|
|
||||||
|
|
||||||
<p> Max number of issues to fetch from GitHub. Default is unlimited</p>
|
|
||||||
|
|
||||||
<p> --release-url [URL]</p>
|
|
||||||
|
|
||||||
<p> The URL to point to for release links, in printf format (with the tag as variable).</p>
|
|
||||||
|
|
||||||
<p> --github-site [URL]</p>
|
|
||||||
|
|
||||||
<p> The Enterprise Github site on which your project is hosted.</p>
|
|
||||||
|
|
||||||
<p> --github-api [URL]</p>
|
|
||||||
|
|
||||||
<p> The enterprise endpoint to use for your Github API.</p>
|
|
||||||
|
|
||||||
<p> --simple-list</p>
|
|
||||||
|
|
||||||
<p> Create simple list from issues and pull requests. Default is false.</p>
|
|
||||||
|
|
||||||
<p> --future-release [RELEASE-VERSION]</p>
|
|
||||||
|
|
||||||
<p> Put the unreleased changes in the specified release number.</p>
|
|
||||||
|
|
||||||
<p> --release-branch [RELEASE-BRANCH]</p>
|
|
||||||
|
|
||||||
<p> Limit pull requests to the release branch, such as master or release</p>
|
|
||||||
|
|
||||||
<p> --http-cache</p>
|
|
||||||
|
|
||||||
<p> Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.</p>
|
|
||||||
|
|
||||||
<p> --[no-]cache-file [CACHE-FILE]</p>
|
|
||||||
|
|
||||||
<p> Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
|
|
||||||
|
|
||||||
<p> --cache-log [CACHE-LOG]</p>
|
|
||||||
|
|
||||||
<p> Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
|
|
||||||
|
|
||||||
<p> --[no-]verbose</p>
|
|
||||||
|
|
||||||
<p> Run verbosely. Default is true</p>
|
|
||||||
|
|
||||||
<p> -v, --version</p>
|
|
||||||
|
|
||||||
<p> Print version number</p>
|
|
||||||
|
|
||||||
<p> -h, --help</p>
|
|
||||||
|
|
||||||
<p> Displays Help</p>
|
|
||||||
|
|
||||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
||||||
|
|
||||||
<h2 id="AUTHOR">AUTHOR</h2>
|
|
||||||
|
|
||||||
<p>Written by Petr Korolev sky4winder@gmail.com</p>
|
|
||||||
|
|
||||||
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
|
||||||
|
|
||||||
<p><<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>></p>
|
|
||||||
|
|
||||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
||||||
|
|
||||||
<p><<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>></p>
|
|
||||||
|
|
||||||
|
|
||||||
<ol class='man-decor man-foot man foot'>
|
|
||||||
<li class='tl'></li>
|
|
||||||
<li class='tc'>December 2016</li>
|
|
||||||
<li class='tr'>git-generate-changelog(1)</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,258 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
|
||||||
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
|
||||||
<title>git-generate-changelog(1) - Generate changelog from github</title>
|
|
||||||
<style type='text/css' media='all'>
|
|
||||||
/* style: man */
|
|
||||||
body#manpage {margin:0}
|
|
||||||
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
||||||
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
||||||
.mp h2 {margin:10px 0 0 0}
|
|
||||||
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
||||||
.mp h3 {margin:0 0 0 4ex}
|
|
||||||
.mp dt {margin:0;clear:left}
|
|
||||||
.mp dt.flush {float:left;width:8ex}
|
|
||||||
.mp dd {margin:0 0 0 9ex}
|
|
||||||
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
||||||
.mp pre {margin-bottom:20px}
|
|
||||||
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
||||||
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
||||||
.mp img {display:block;margin:auto}
|
|
||||||
.mp h1.man-title {display:none}
|
|
||||||
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
||||||
.mp h2 {font-size:16px;line-height:1.25}
|
|
||||||
.mp h1 {font-size:20px;line-height:2}
|
|
||||||
.mp {text-align:justify;background:#fff}
|
|
||||||
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
||||||
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
||||||
.mp u {text-decoration:underline}
|
|
||||||
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
||||||
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
||||||
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
||||||
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
||||||
.mp pre {padding:0 4ex}
|
|
||||||
.mp pre code {font-weight:normal;color:#434241}
|
|
||||||
.mp h2+pre,h3+pre {padding-left:0}
|
|
||||||
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
||||||
ol.man-decor {width:100%}
|
|
||||||
ol.man-decor li.tl {text-align:left}
|
|
||||||
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
||||||
ol.man-decor li.tr {text-align:right;float:right}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<!--
|
|
||||||
The following styles are deprecated and will be removed at some point:
|
|
||||||
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
||||||
|
|
||||||
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
||||||
.man-navigation should be used instead.
|
|
||||||
-->
|
|
||||||
<body id='manpage'>
|
|
||||||
<div class='mp' id='man'>
|
|
||||||
|
|
||||||
<div class='man-navigation' style='display:none'>
|
|
||||||
<a href="#NAME">NAME</a>
|
|
||||||
<a href="#SYNOPSIS">SYNOPSIS</a>
|
|
||||||
<a href="#DESCRIPTION">DESCRIPTION</a>
|
|
||||||
<a href="#OPTIONS">OPTIONS</a>
|
|
||||||
<a href="#EXAMPLES">EXAMPLES</a>
|
|
||||||
<a href="#AUTHOR">AUTHOR</a>
|
|
||||||
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
|
|
||||||
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<ol class='man-decor man-head man head'>
|
|
||||||
<li class='tl'>git-generate-changelog(1)</li>
|
|
||||||
<li class='tc'></li>
|
|
||||||
<li class='tr'>git-generate-changelog(1)</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
<h2 id="NAME">NAME</h2>
|
|
||||||
<p class="man-name">
|
|
||||||
<code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
||||||
|
|
||||||
<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
|
|
||||||
|
|
||||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
||||||
|
|
||||||
<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
|
|
||||||
|
|
||||||
<h2 id="OPTIONS">OPTIONS</h2>
|
|
||||||
|
|
||||||
<p> -u, --user [USER]</p>
|
|
||||||
|
|
||||||
<p> Username of the owner of target GitHub repo</p>
|
|
||||||
|
|
||||||
<p> -p, --project [PROJECT]</p>
|
|
||||||
|
|
||||||
<p> Name of project on GitHub</p>
|
|
||||||
|
|
||||||
<p> -t, --token [TOKEN]</p>
|
|
||||||
|
|
||||||
<p> To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
|
|
||||||
|
|
||||||
<p> -f, --date-format [FORMAT]</p>
|
|
||||||
|
|
||||||
<p> Date format. Default is %Y-%m-%d</p>
|
|
||||||
|
|
||||||
<p> -o, --output [NAME]</p>
|
|
||||||
|
|
||||||
<p> Output file. Default is CHANGELOG.md</p>
|
|
||||||
|
|
||||||
<p> -b, --base [NAME]</p>
|
|
||||||
|
|
||||||
<p> Optional base file to append generated changes to.</p>
|
|
||||||
|
|
||||||
<p> --bugs-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
|
|
||||||
|
|
||||||
<p> --enhancement-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
|
|
||||||
|
|
||||||
<p> --issues-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
|
|
||||||
|
|
||||||
<p> --header-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom header label. Default is "# Change Log"</p>
|
|
||||||
|
|
||||||
<p> --pr-label [LABEL]</p>
|
|
||||||
|
|
||||||
<p> Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
|
|
||||||
|
|
||||||
<p> --[no-]issues</p>
|
|
||||||
|
|
||||||
<p> Include closed issues in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]issues-wo-labels</p>
|
|
||||||
|
|
||||||
<p> Include closed issues without labels in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]pr-wo-labels</p>
|
|
||||||
|
|
||||||
<p> Include pull requests without labels in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]pull-requests</p>
|
|
||||||
|
|
||||||
<p> Include pull-requests in changelog. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]filter-by-milestone</p>
|
|
||||||
|
|
||||||
<p> Use milestone to detect when issue was resolved. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]author</p>
|
|
||||||
|
|
||||||
<p> Add author of pull-request in the end. Default is true</p>
|
|
||||||
|
|
||||||
<p> --unreleased-only</p>
|
|
||||||
|
|
||||||
<p> Generate log from unreleased closed issues only.</p>
|
|
||||||
|
|
||||||
<p> --[no-]unreleased</p>
|
|
||||||
|
|
||||||
<p> Add to log unreleased closed issues. Default is true</p>
|
|
||||||
|
|
||||||
<p> --unreleased-label [label]</p>
|
|
||||||
|
|
||||||
<p> Add to log unreleased closed issues. Default is true</p>
|
|
||||||
|
|
||||||
<p> --[no-]compare-link</p>
|
|
||||||
|
|
||||||
<p> Include compare link (Full Changelog) between older version and newer version. Default is true</p>
|
|
||||||
|
|
||||||
<p> --include-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Only issues with the specified labels will be included in the changelog.</p>
|
|
||||||
|
|
||||||
<p> --exclude-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
|
|
||||||
|
|
||||||
<p> --bug-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
|
|
||||||
|
|
||||||
<p> --enhancement-labels x,y,z</p>
|
|
||||||
|
|
||||||
<p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
|
|
||||||
|
|
||||||
<p> --exclude-tags x,y,z</p>
|
|
||||||
|
|
||||||
<p> Change log will exclude specified tags</p>
|
|
||||||
|
|
||||||
<p> --since-tag x</p>
|
|
||||||
|
|
||||||
<p> Change log will start after specified tag</p>
|
|
||||||
|
|
||||||
<p> --due-tag x</p>
|
|
||||||
|
|
||||||
<p> Change log will end before specified tag</p>
|
|
||||||
|
|
||||||
<p> --max-issues [NUMBER]</p>
|
|
||||||
|
|
||||||
<p> Max number of issues to fetch from GitHub. Default is unlimited</p>
|
|
||||||
|
|
||||||
<p> --release-url [URL]</p>
|
|
||||||
|
|
||||||
<p> The URL to point to for release links, in printf format (with the tag as variable).</p>
|
|
||||||
|
|
||||||
<p> --github-site [URL]</p>
|
|
||||||
|
|
||||||
<p> The Enterprise Github site on which your project is hosted.</p>
|
|
||||||
|
|
||||||
<p> --github-api [URL]</p>
|
|
||||||
|
|
||||||
<p> The enterprise endpoint to use for your Github API.</p>
|
|
||||||
|
|
||||||
<p> --simple-list</p>
|
|
||||||
|
|
||||||
<p> Create simple list from issues and pull requests. Default is false.</p>
|
|
||||||
|
|
||||||
<p> --future-release [RELEASE-VERSION]</p>
|
|
||||||
|
|
||||||
<p> Put the unreleased changes in the specified release number.</p>
|
|
||||||
|
|
||||||
<p> --[no-]verbose</p>
|
|
||||||
|
|
||||||
<p> Run verbosely. Default is true</p>
|
|
||||||
|
|
||||||
<p> -v, --version</p>
|
|
||||||
|
|
||||||
<p> Print version number</p>
|
|
||||||
|
|
||||||
<p> -h, --help</p>
|
|
||||||
|
|
||||||
<p> Displays Help</p>
|
|
||||||
|
|
||||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
||||||
|
|
||||||
<h2 id="AUTHOR">AUTHOR</h2>
|
|
||||||
|
|
||||||
<p>Written by Petr Korolev sky4winder@gmail.com</p>
|
|
||||||
|
|
||||||
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
|
||||||
|
|
||||||
<p><<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>></p>
|
|
||||||
|
|
||||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
||||||
|
|
||||||
<p><<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>></p>
|
|
||||||
|
|
||||||
|
|
||||||
<ol class='man-decor man-foot man foot'>
|
|
||||||
<li class='tl'></li>
|
|
||||||
<li class='tc'>October 2015</li>
|
|
||||||
<li class='tr'>git-generate-changelog(1)</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,207 +0,0 @@
|
|||||||
git-generate-changelog(1) - Generate changelog from github
|
|
||||||
================================
|
|
||||||
|
|
||||||
## SYNOPSIS
|
|
||||||
|
|
||||||
`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]
|
|
||||||
|
|
||||||
## DESCRIPTION
|
|
||||||
|
|
||||||
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
|
|
||||||
|
|
||||||
## OPTIONS
|
|
||||||
|
|
||||||
-u, --user [USER]
|
|
||||||
|
|
||||||
Username of the owner of target GitHub repo
|
|
||||||
|
|
||||||
-p, --project [PROJECT]
|
|
||||||
|
|
||||||
Name of project on GitHub
|
|
||||||
|
|
||||||
-t, --token [TOKEN]
|
|
||||||
|
|
||||||
To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new
|
|
||||||
|
|
||||||
-f, --date-format [FORMAT]
|
|
||||||
|
|
||||||
Date format. Default is %Y-%m-%d
|
|
||||||
|
|
||||||
-o, --output [NAME]
|
|
||||||
|
|
||||||
Output file. Default is CHANGELOG.md
|
|
||||||
|
|
||||||
-b, --base [NAME]
|
|
||||||
|
|
||||||
Optional base file to append generated changes to.
|
|
||||||
|
|
||||||
--bugs-label [LABEL]
|
|
||||||
|
|
||||||
Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
|
|
||||||
|
|
||||||
--enhancement-label [LABEL]
|
|
||||||
|
|
||||||
Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
|
|
||||||
|
|
||||||
--issues-label [LABEL]
|
|
||||||
|
|
||||||
Setup custom label for closed-issues section. Default is "**Closed issues:**"
|
|
||||||
|
|
||||||
--header-label [LABEL]
|
|
||||||
|
|
||||||
Setup custom header label. Default is "# Change Log"
|
|
||||||
|
|
||||||
--front-matter [JSON]
|
|
||||||
|
|
||||||
Add YAML front matter. Formatted as JSON because it's easier to add on the command line
|
|
||||||
|
|
||||||
--pr-label [LABEL]
|
|
||||||
|
|
||||||
Setup custom label for pull requests section. Default is "**Merged pull requests:**"
|
|
||||||
|
|
||||||
--[no-]issues
|
|
||||||
|
|
||||||
Include closed issues in changelog. Default is true
|
|
||||||
|
|
||||||
--[no-]issues-wo-labels
|
|
||||||
|
|
||||||
Include closed issues without labels in changelog. Default is true
|
|
||||||
|
|
||||||
--[no-]pr-wo-labels
|
|
||||||
|
|
||||||
Include pull requests without labels in changelog. Default is true
|
|
||||||
|
|
||||||
--[no-]pull-requests
|
|
||||||
|
|
||||||
Include pull-requests in changelog. Default is true
|
|
||||||
|
|
||||||
--[no-]filter-by-milestone
|
|
||||||
|
|
||||||
Use milestone to detect when issue was resolved. Default is true
|
|
||||||
|
|
||||||
--[no-]author
|
|
||||||
|
|
||||||
Add author of pull-request in the end. Default is true
|
|
||||||
|
|
||||||
--usernames-as-github-logins
|
|
||||||
|
|
||||||
Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
|
|
||||||
|
|
||||||
--unreleased-only
|
|
||||||
|
|
||||||
Generate log from unreleased closed issues only.
|
|
||||||
|
|
||||||
--[no-]unreleased
|
|
||||||
|
|
||||||
Add to log unreleased closed issues. Default is true
|
|
||||||
|
|
||||||
--unreleased-label [label]
|
|
||||||
|
|
||||||
Setup custom label for unreleased closed issues section. Default is "**Unreleased:**"
|
|
||||||
|
|
||||||
--[no-]compare-link
|
|
||||||
|
|
||||||
Include compare link (Full Changelog) between older version and newer version. Default is true
|
|
||||||
|
|
||||||
--include-labels x,y,z
|
|
||||||
|
|
||||||
Only issues with the specified labels will be included in the changelog.
|
|
||||||
|
|
||||||
--exclude-labels x,y,z
|
|
||||||
|
|
||||||
Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
|
||||||
|
|
||||||
--bug-labels x,y,z
|
|
||||||
|
|
||||||
Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
|
|
||||||
|
|
||||||
--enhancement-labels x,y,z
|
|
||||||
|
|
||||||
Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
|
|
||||||
|
|
||||||
--exclude-tags x,y,z
|
|
||||||
|
|
||||||
Change log will exclude specified tags
|
|
||||||
|
|
||||||
--exclude-tags-regex [REGEX]
|
|
||||||
|
|
||||||
Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}"
|
|
||||||
|
|
||||||
--since-tag x
|
|
||||||
|
|
||||||
Change log will start after specified tag
|
|
||||||
|
|
||||||
--due-tag x
|
|
||||||
|
|
||||||
Change log will end before specified tag
|
|
||||||
|
|
||||||
--max-issues [NUMBER]
|
|
||||||
|
|
||||||
Max number of issues to fetch from GitHub. Default is unlimited
|
|
||||||
|
|
||||||
--release-url [URL]
|
|
||||||
|
|
||||||
The URL to point to for release links, in printf format (with the tag as variable).
|
|
||||||
|
|
||||||
--github-site [URL]
|
|
||||||
|
|
||||||
The Enterprise Github site on which your project is hosted.
|
|
||||||
|
|
||||||
--github-api [URL]
|
|
||||||
|
|
||||||
The enterprise endpoint to use for your Github API.
|
|
||||||
|
|
||||||
--simple-list
|
|
||||||
|
|
||||||
Create simple list from issues and pull requests. Default is false.
|
|
||||||
|
|
||||||
--future-release [RELEASE-VERSION]
|
|
||||||
|
|
||||||
Put the unreleased changes in the specified release number.
|
|
||||||
|
|
||||||
--release-branch [RELEASE-BRANCH]
|
|
||||||
|
|
||||||
Limit pull requests to the release branch, such as master or release
|
|
||||||
|
|
||||||
--http-cache
|
|
||||||
|
|
||||||
Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.
|
|
||||||
|
|
||||||
--[no-]cache-file [CACHE-FILE]
|
|
||||||
|
|
||||||
Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
|
|
||||||
|
|
||||||
--cache-log [CACHE-LOG]
|
|
||||||
|
|
||||||
Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
|
|
||||||
|
|
||||||
--ssl-ca-file [PATH]
|
|
||||||
|
|
||||||
Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
|
|
||||||
|
|
||||||
--[no-]verbose
|
|
||||||
|
|
||||||
Run verbosely. Default is true
|
|
||||||
|
|
||||||
-v, --version
|
|
||||||
|
|
||||||
Print version number
|
|
||||||
|
|
||||||
-h, --help
|
|
||||||
|
|
||||||
Displays Help
|
|
||||||
|
|
||||||
|
|
||||||
## EXAMPLES
|
|
||||||
|
|
||||||
## AUTHOR
|
|
||||||
|
|
||||||
Written by Petr Korolev sky4winder@gmail.com
|
|
||||||
|
|
||||||
## REPORTING BUGS
|
|
||||||
|
|
||||||
<<https://github.com/skywinder/github-changelog-generator/issues>>
|
|
||||||
|
|
||||||
## SEE ALSO
|
|
||||||
|
|
||||||
<<https://github.com/skywinder/github-changelog-generator/>>
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
source "https://rubygems.org"
|
|
||||||
|
|
||||||
gem "github_changelog_generator", path: Dir.glob("../pkg/github_changelog_generator-*.gem")[0]
|
|
||||||
@@ -1,5 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Author:: Enrico Stahn <mail@enricostahn.com>
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
#
|
#
|
||||||
@@ -17,62 +15,107 @@
|
|||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
#
|
#
|
||||||
|
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
|
||||||
end
|
end
|
||||||
|
|
||||||
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
|
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
||||||
Coveralls::SimpleCov::Formatter,
|
Coveralls::SimpleCov::Formatter,
|
||||||
SimpleCov::Formatter::HTMLFormatter
|
SimpleCov::Formatter::HTMLFormatter,
|
||||||
])
|
CodeClimate::TestReporter::Formatter
|
||||||
SimpleCov.start do
|
]
|
||||||
add_filter "gemfiles/"
|
SimpleCov.start
|
||||||
end
|
|
||||||
|
|
||||||
require "github_changelog_generator"
|
require "github_changelog_generator"
|
||||||
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
|
|
||||||
|
|
||||||
|
# This file was generated by the `rspec --init` command. Conventionally, all
|
||||||
|
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
|
||||||
|
# The generated `.rspec` file contains `--require spec_helper` which will cause
|
||||||
|
# this file to always be loaded, without a need to explicitly require it in any
|
||||||
|
# files.
|
||||||
|
#
|
||||||
|
# Given that it is always loaded, you are encouraged to keep this file as
|
||||||
|
# light-weight as possible. Requiring heavyweight dependencies from this file
|
||||||
|
# will add to the boot time of your test suite on EVERY test run, even for an
|
||||||
|
# individual file that may not need all of that loaded. Instead, consider making
|
||||||
|
# a separate helper file that requires the additional dependencies and performs
|
||||||
|
# the additional setup, and require it from the spec files that actually need
|
||||||
|
# it.
|
||||||
|
#
|
||||||
|
# The `.rspec` file also contains a few flags that are not defaults but that
|
||||||
|
# users commonly want.
|
||||||
|
#
|
||||||
|
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
|
||||||
RSpec.configure do |config|
|
RSpec.configure do |config|
|
||||||
|
# rspec-expectations config goes here. You can use an alternate
|
||||||
|
# assertion/expectation library such as wrong or the stdlib/minitest
|
||||||
|
# assertions if you prefer.
|
||||||
config.expect_with :rspec do |expectations|
|
config.expect_with :rspec do |expectations|
|
||||||
|
# This option will default to `true` in RSpec 4. It makes the `description`
|
||||||
|
# and `failure_message` of custom matchers include text for helper methods
|
||||||
|
# defined using `chain`, e.g.:
|
||||||
|
# be_bigger_than(2).and_smaller_than(4).description
|
||||||
|
# # => "be bigger than 2 and smaller than 4"
|
||||||
|
# ...rather than:
|
||||||
|
# # => "be bigger than 2"
|
||||||
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# rspec-mocks config goes here. You can use an alternate test double
|
||||||
|
# library (such as bogus or mocha) by changing the `mock_with` option here.
|
||||||
config.mock_with :rspec do |mocks|
|
config.mock_with :rspec do |mocks|
|
||||||
|
# Prevents you from mocking or stubbing a method that does not exist on
|
||||||
|
# a real object. This is generally recommended, and will default to
|
||||||
|
# `true` in RSpec 4.
|
||||||
mocks.verify_partial_doubles = true
|
mocks.verify_partial_doubles = true
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# These two settings work together to allow you to limit a spec run
|
||||||
|
# to individual examples or groups you care about by tagging them with
|
||||||
|
# `:focus` metadata. When nothing is tagged with `:focus`, all examples
|
||||||
|
# get run.
|
||||||
config.filter_run :focus
|
config.filter_run :focus
|
||||||
config.run_all_when_everything_filtered = true
|
config.run_all_when_everything_filtered = true
|
||||||
|
|
||||||
|
# Limits the available syntax to the non-monkey patched syntax that is
|
||||||
|
# recommended. For more details, see:
|
||||||
|
# - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
|
||||||
|
# - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
|
||||||
|
# - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
|
||||||
|
# config.disable_monkey_patching!
|
||||||
|
|
||||||
|
# This setting enables warnings. It's recommended, but in some cases may
|
||||||
|
# be too noisy due to issues in dependencies.
|
||||||
config.warnings = true
|
config.warnings = true
|
||||||
|
|
||||||
config.default_formatter = "doc" if config.files_to_run.one?
|
# Many RSpec users commonly either run the entire suite or an individual
|
||||||
|
# file, and it's useful to allow more verbose output when running an
|
||||||
|
# individual spec file.
|
||||||
|
if config.files_to_run.one?
|
||||||
|
# Use the documentation formatter for detailed output,
|
||||||
|
# unless a formatter has already been configured
|
||||||
|
# (e.g. via a command-line flag).
|
||||||
|
config.default_formatter = "doc"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Print the 10 slowest examples and example groups at the
|
||||||
|
# end of the spec run, to help surface which specs are running
|
||||||
|
# particularly slow.
|
||||||
|
# config.profile_examples = 10
|
||||||
|
|
||||||
|
# Run specs in random order to surface order dependencies. If you find an
|
||||||
|
# order dependency and want to debug it, you can fix the order by providing
|
||||||
|
# the seed, which is printed after each run.
|
||||||
|
# --seed 1234
|
||||||
config.order = :random
|
config.order = :random
|
||||||
|
|
||||||
|
# Seed global randomization in this process using the `--seed` CLI option.
|
||||||
|
# Setting this allows you to use `--seed` to deterministically reproduce
|
||||||
|
# test failures related to randomization by passing the same `--seed` value
|
||||||
|
# as the one that triggered the failure.
|
||||||
Kernel.srand config.seed
|
Kernel.srand config.seed
|
||||||
end
|
end
|
||||||
|
|||||||
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,17 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
describe Generator do
|
|
||||||
describe "#get_string_for_issue" do
|
|
||||||
let(:issue) do
|
|
||||||
{ "title" => "Bug in code" }
|
|
||||||
end
|
|
||||||
|
|
||||||
it "formats an issue according to options" do
|
|
||||||
expect do
|
|
||||||
described_class.new.get_string_for_issue(issue)
|
|
||||||
end.not_to raise_error
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
|
||||||
describe Generator do
|
|
||||||
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
|
|
||||||
let(:options) { {} }
|
|
||||||
let(:generator) { described_class.new(default_options.merge(options)) }
|
|
||||||
|
|
||||||
let(:bad_label) { { "name" => "BAD" } }
|
|
||||||
let(:bad_issue) { { "labels" => [bad_label] } }
|
|
||||||
let(:good_label) { { "name" => "GOOD" } }
|
|
||||||
let(:good_issue) { { "labels" => [good_label] } }
|
|
||||||
let(:unlabeled_issue) { { "labels" => [] } }
|
|
||||||
let(:issues) { [bad_issue, good_issue, unlabeled_issue] }
|
|
||||||
|
|
||||||
describe "#exclude_issues_by_labels" do
|
|
||||||
subject do
|
|
||||||
generator.exclude_issues_by_labels(issues)
|
|
||||||
end
|
|
||||||
|
|
||||||
let(:expected_issues) { issues }
|
|
||||||
|
|
||||||
it { is_expected.to eq(expected_issues) }
|
|
||||||
|
|
||||||
context "when 'exclude_lables' is provided" do
|
|
||||||
let(:options) { { exclude_labels: %w[BAD BOO] } }
|
|
||||||
let(:expected_issues) { [good_issue, unlabeled_issue] }
|
|
||||||
|
|
||||||
it { is_expected.to eq(expected_issues) }
|
|
||||||
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
|
|
||||||
|
|
||||||
describe "#get_filtered_issues" do
|
|
||||||
subject do
|
|
||||||
generator.get_filtered_issues(issues)
|
|
||||||
end
|
|
||||||
|
|
||||||
let(:expected_issues) { issues }
|
|
||||||
|
|
||||||
it { is_expected.to eq(expected_issues) }
|
|
||||||
|
|
||||||
context "when 'exclude_labels' is provided" do
|
|
||||||
let(:options) { { exclude_labels: %w[BAD BOO] } }
|
|
||||||
let(:expected_issues) { [good_issue, unlabeled_issue] }
|
|
||||||
|
|
||||||
it { is_expected.to eq(expected_issues) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when 'add_issues_wo_labels' is false" do
|
|
||||||
let(:options) { { add_issues_wo_labels: false } }
|
|
||||||
let(:expected_issues) { [bad_issue, good_issue] }
|
|
||||||
|
|
||||||
it { is_expected.to eq(expected_issues) }
|
|
||||||
|
|
||||||
context "with 'exclude_labels'" do
|
|
||||||
let(:options) { { add_issues_wo_labels: false, exclude_labels: %w[GOOD] } }
|
|
||||||
let(:expected_issues) { [bad_issue] }
|
|
||||||
|
|
||||||
it { is_expected.to eq(expected_issues) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when 'include_labels' is specified" do
|
|
||||||
let(:options) { { include_labels: %w[GOOD] } }
|
|
||||||
let(:expected_issues) { [good_issue] }
|
|
||||||
|
|
||||||
it { is_expected.to eq(expected_issues) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,244 +1,107 @@
|
|||||||
# 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)
|
describe "#filter_between_tags" do
|
||||||
{
|
context "when between_tags nil" do
|
||||||
"name" => tag
|
before do
|
||||||
}
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
|
||||||
end
|
end
|
||||||
|
|
||||||
def tags_from_strings(tags_strings)
|
subject do
|
||||||
tags_strings.map do |tag|
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
tag_with_name(tag)
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
end
|
||||||
|
context "when between_tags same as input array" do
|
||||||
|
before do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
|
||||||
|
end
|
||||||
|
subject do
|
||||||
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
end
|
||||||
|
|
||||||
|
context "when between_tags filled with correct values" do
|
||||||
|
before do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
|
||||||
|
end
|
||||||
|
subject do
|
||||||
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
||||||
|
end
|
||||||
|
|
||||||
|
context "when between_tags filled with invalid values" do
|
||||||
|
before do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
|
||||||
|
end
|
||||||
|
|
||||||
|
subject do
|
||||||
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe "#tag_section_mapping" do
|
describe "#get_filtered_tags" do
|
||||||
let(:all_tags) { tags_from_strings(%w[8 7 6 5 4 3 2 1]) }
|
|
||||||
let(:sorted_tags) { all_tags }
|
|
||||||
|
|
||||||
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
|
|
||||||
let(:options) { {} }
|
|
||||||
let(:generator) { described_class.new(default_options.merge(options)) }
|
|
||||||
|
|
||||||
before do
|
|
||||||
allow_any_instance_of(GitHubChangelogGenerator::OctoFetcher).to receive(:get_all_tags).and_return(all_tags)
|
|
||||||
allow(generator).to receive(:fetch_tags_dates).with(all_tags)
|
|
||||||
allow(generator).to receive(:sort_tags_by_date).with(all_tags).and_return(sorted_tags)
|
|
||||||
generator.fetch_and_filter_tags
|
|
||||||
end
|
|
||||||
|
|
||||||
subject do
|
subject do
|
||||||
generator.tag_section_mapping
|
generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3 4 5)))
|
||||||
end
|
end
|
||||||
|
|
||||||
shared_examples_for "a section mapping" do
|
context "with excluded and between tags" do
|
||||||
it { is_expected.to be_a(Hash) }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
|
||||||
it { is_expected.to eq(expected_mapping) }
|
it { is_expected.to be_a Array }
|
||||||
end
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 3))) }
|
||||||
|
|
||||||
shared_examples_for "a full changelog" do
|
|
||||||
let(:expected_mapping) do
|
|
||||||
{
|
|
||||||
tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
|
|
||||||
tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")],
|
|
||||||
tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
|
|
||||||
tag_with_name("5") => [tag_with_name("4"), tag_with_name("5")],
|
|
||||||
tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
|
|
||||||
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
|
|
||||||
tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
|
|
||||||
tag_with_name("1") => [nil, tag_with_name("1")]
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
it_behaves_like "a section mapping"
|
|
||||||
end
|
|
||||||
|
|
||||||
shared_examples_for "a changelog with some exclusions" do
|
|
||||||
let(:expected_mapping) do
|
|
||||||
{
|
|
||||||
tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
|
|
||||||
tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
|
|
||||||
tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
|
|
||||||
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
|
|
||||||
tag_with_name("1") => [nil, tag_with_name("1")]
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
it_behaves_like "a section mapping"
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with no constraints" do
|
|
||||||
it_behaves_like "a full changelog"
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with since only" do
|
|
||||||
let(:options) { { since_tag: "6" } }
|
|
||||||
let(:expected_mapping) do
|
|
||||||
{
|
|
||||||
tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
|
|
||||||
tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")]
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
it_behaves_like "a section mapping"
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with due only" do
|
|
||||||
let(:options) { { due_tag: "4" } }
|
|
||||||
let(:expected_mapping) do
|
|
||||||
{
|
|
||||||
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
|
|
||||||
tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
|
|
||||||
tag_with_name("1") => [nil, tag_with_name("1")]
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
it_behaves_like "a section mapping"
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with since and due" do
|
|
||||||
let(:options) { { since_tag: "2", due_tag: "5" } }
|
|
||||||
let(:expected_mapping) do
|
|
||||||
{
|
|
||||||
tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
|
|
||||||
tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")]
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
it_behaves_like "a section mapping"
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with excluded tags" do
|
|
||||||
context "as a list of strings" do
|
|
||||||
let(:options) { { exclude_tags: %w[2 5 7] } }
|
|
||||||
|
|
||||||
it_behaves_like "a changelog with some exclusions"
|
|
||||||
end
|
|
||||||
|
|
||||||
context "as a regex" do
|
|
||||||
let(:options) { { exclude_tags: /[257]/ } }
|
|
||||||
|
|
||||||
it_behaves_like "a changelog with some exclusions"
|
|
||||||
end
|
|
||||||
|
|
||||||
context "as a regex string" do
|
|
||||||
let(:options) { { exclude_tags_regex: "[257]" } }
|
|
||||||
|
|
||||||
it_behaves_like "a changelog with some exclusions"
|
|
||||||
end
|
|
||||||
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
|
|
||||||
|
|
||||||
context "with matching regex" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[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: /[abc]/) }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_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
|
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
subject { generator.filter_since_tag(tags_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 2])) }
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid since tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
context "with empty array" do
|
context "with invalid since tag" do
|
||||||
subject { generator.filter_since_tag(tags_from_strings(%w[])) }
|
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: %w(invalid tags)) }
|
||||||
|
it { is_expected.to be_a Array }
|
||||||
context "with valid since tag" do
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_from_strings(%w[])) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid since tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_from_strings(%w[])) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#filter_due_tag" do
|
|
||||||
context "with filled array" do
|
|
||||||
subject { generator.filter_due_tag(tags_from_strings(%w[1 2 3])) }
|
|
||||||
|
|
||||||
context "with valid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_from_strings(%w[3])) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with empty array" do
|
|
||||||
subject { generator.filter_due_tag(tags_from_strings(%w[])) }
|
|
||||||
|
|
||||||
context "with valid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_from_strings(%w[])) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with invalid due tag" do
|
|
||||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
|
||||||
it { is_expected.to be_a Array }
|
|
||||||
it { is_expected.to match_array(tags_from_strings(%w[])) }
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -252,7 +115,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
|
||||||
@@ -263,7 +126,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) }
|
||||||
@@ -272,32 +135,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,543 +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 "#check_github_response" do
|
|
||||||
context "when returns successfully" do
|
|
||||||
it "returns block value" do
|
|
||||||
expect(fetcher.send(:check_github_response) { 1 + 1 }).to eq(2)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when raises Octokit::Unauthorized" do
|
|
||||||
it "aborts" do
|
|
||||||
expect(fetcher).to receive(:sys_abort).with("Error: wrong GitHub token")
|
|
||||||
fetcher.send(:check_github_response) { raise(Octokit::Unauthorized) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when raises Octokit::Forbidden" do
|
|
||||||
it "sleeps and retries and then aborts" do
|
|
||||||
retry_limit = GitHubChangelogGenerator::OctoFetcher::MAX_FORBIDDEN_RETRIES - 1
|
|
||||||
allow(fetcher).to receive(:sleep_base_interval).exactly(retry_limit).times.and_return(0)
|
|
||||||
|
|
||||||
expect(fetcher).to receive(:sys_abort).with("Exceeded retry limit")
|
|
||||||
fetcher.send(:check_github_response) { raise(Octokit::Forbidden) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
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 "#querystring_as_hash" do
|
|
||||||
it "works on the blank URL" do
|
|
||||||
expect { fetcher.send(:querystring_as_hash, "") }.not_to raise_error
|
|
||||||
end
|
|
||||||
|
|
||||||
it "where there are no querystring params" do
|
|
||||||
expect { fetcher.send(:querystring_as_hash, "http://example.com") }.not_to raise_error
|
|
||||||
end
|
|
||||||
|
|
||||||
it "returns a String-keyed Hash of querystring params" do
|
|
||||||
expect(fetcher.send(:querystring_as_hash, "http://example.com/o.html?str=18&wis=12")).to include("wis" => "12", "str" => "18")
|
|
||||||
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
|
|
||||||
|
|
||||||
describe "#commits_before" do
|
|
||||||
context "when API is valid", :vcr do
|
|
||||||
let(:start_time) { Time.parse("Wed Mar 4 18:47:17 2015 +0200") }
|
|
||||||
|
|
||||||
subject do
|
|
||||||
fetcher.commits_before(start_time)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "returns commits" do
|
|
||||||
expect(subject.last["sha"]).to eq("4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
RSpec.describe GitHubChangelogGenerator::Options do
|
|
||||||
describe "#initialize" do
|
|
||||||
context "with known options" do
|
|
||||||
it "instantiates successfully" do
|
|
||||||
expect(described_class.new(user: "olle")[:user]).to eq("olle")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with unknown options" do
|
|
||||||
it "raises an error" do
|
|
||||||
expect do
|
|
||||||
described_class.new(
|
|
||||||
git_remote: "origin",
|
|
||||||
strength: "super-strength",
|
|
||||||
wisdom: "deep"
|
|
||||||
)
|
|
||||||
end.to raise_error("[:strength, :wisdom]")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe "#[]=(key, value)" do
|
|
||||||
let(:options) { described_class.new(git_remote: "origin") }
|
|
||||||
|
|
||||||
context "with known options" do
|
|
||||||
it "sets the option value" do
|
|
||||||
expect do
|
|
||||||
options[:git_remote] = "in the cloud"
|
|
||||||
end.to change { options[:git_remote] }.to "in the cloud"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "with unknown options" do
|
|
||||||
it "raises an error" do
|
|
||||||
expect do
|
|
||||||
options[:charisma] = 8
|
|
||||||
end.to raise_error(":charisma")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
describe GitHubChangelogGenerator::ParserFile do
|
|
||||||
describe ".github_changelog_generator" do
|
|
||||||
let(:options) { {} }
|
|
||||||
|
|
||||||
context "when the well-known default file does not exist" do
|
|
||||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
|
|
||||||
subject { parser.parse! }
|
|
||||||
it { is_expected.to be_nil }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when file is empty" do
|
|
||||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
|
|
||||||
|
|
||||||
it "does not change the options" do
|
|
||||||
expect { parser.parse! }.to_not(change { options })
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when file is incorrect" do
|
|
||||||
let(:options_before_change) { options.dup }
|
|
||||||
let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
|
|
||||||
let(:parser) do
|
|
||||||
GitHubChangelogGenerator::ParserFile.new(options, file)
|
|
||||||
end
|
|
||||||
it { expect { parser.parse! }.to raise_error(/line #2/) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "allows empty lines and comments with semi-colon or pound sign" do
|
|
||||||
let(:file) { StringIO.new("\n \n# Comment on first line\nunreleased_label=staging\n; Comment on third line\nunreleased=false") }
|
|
||||||
let(:parser) do
|
|
||||||
GitHubChangelogGenerator::ParserFile.new(options, file)
|
|
||||||
end
|
|
||||||
it { expect { parser.parse! }.not_to raise_error }
|
|
||||||
end
|
|
||||||
|
|
||||||
context "when override default values" do
|
|
||||||
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
|
|
||||||
let(:options) { {}.merge(default_options) }
|
|
||||||
let(:options_before_change) { options.dup }
|
|
||||||
let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
|
|
||||||
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
|
|
||||||
|
|
||||||
it "changes the options" do
|
|
||||||
expect { parser.parse! }.to change { options }
|
|
||||||
.from(options_before_change)
|
|
||||||
.to(options_before_change.merge(unreleased_label: "staging",
|
|
||||||
unreleased: false,
|
|
||||||
header: "=== Changelog ==="))
|
|
||||||
end
|
|
||||||
|
|
||||||
context "turns exclude-labels into an Array", bug: "#327" do
|
|
||||||
let(:file) do
|
|
||||||
line1 = "exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90\n"
|
|
||||||
line2 = "header_label=# My changelog\n"
|
|
||||||
StringIO.new(line1 + line2)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "reads exclude_labels into an Array" do
|
|
||||||
expect { parser.parse! }.to change { options[:exclude_labels] }
|
|
||||||
.from(default_options[:exclude_labels])
|
|
||||||
.to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
|
|
||||||
end
|
|
||||||
|
|
||||||
it "translates given header_label into the :header option" do
|
|
||||||
expect { parser.parse! }.to change { options[:header] }
|
|
||||||
.from(default_options[:header])
|
|
||||||
.to("# My changelog")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,5 +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
|
||||||
@@ -30,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
|
|||||||
end
|
end
|
||||||
describe ".user_project_from_option" do
|
describe ".user_project_from_option" do
|
||||||
context "when option is invalid" do
|
context "when option is invalid" do
|
||||||
it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
|
it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
|
||||||
end
|
end
|
||||||
|
|
||||||
context "when option is valid" do
|
context "when option is valid" do
|
||||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
end
|
end
|
||||||
context "when option nil" do
|
context "when option nil" do
|
||||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
|
||||||
it { is_expected.to be_a(Array) }
|
it { is_expected.to be_a(Array) }
|
||||||
it { is_expected.to match_array([nil, nil]) }
|
it { is_expected.to match_array([nil, nil]) }
|
||||||
end
|
end
|
||||||
@@ -58,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,5 +1,3 @@
|
|||||||
# frozen_string_literal: true
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Author:: Enrico Stahn <mail@enricostahn.com>
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
#
|
#
|
||||||
@@ -86,6 +84,10 @@ describe GitHubChangelogGenerator::Reader do
|
|||||||
context "angular.js.md" do
|
context "angular.js.md" do
|
||||||
it { is_expected.to be_an(Array) }
|
it { is_expected.to be_an(Array) }
|
||||||
it { is_expected.not_to be_empty }
|
it { is_expected.not_to be_empty }
|
||||||
|
it do
|
||||||
|
pending("Implement heading_level for parser.")
|
||||||
|
expect(subject.count).to eq(134)
|
||||||
|
end
|
||||||
# it do
|
# it do
|
||||||
# pending('Implement heading_level for parser.')
|
# pending('Implement heading_level for parser.')
|
||||||
# expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')
|
# expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')
|
||||||
|
|||||||
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
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