Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b08f881fb1 | ||
|
|
4c7df83a4c |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -7,6 +7,3 @@ coverage/
|
||||
spec/*.lock
|
||||
doc
|
||||
.yardoc
|
||||
Gemfile.lock
|
||||
gemfiles/Gemfile.2_4_0.lock
|
||||
gemfiles/Gemfile.jruby-9.1.5.0.lock
|
||||
|
||||
13
.rubocop.yml
13
.rubocop.yml
@@ -1,12 +1,5 @@
|
||||
inherit_from: .rubocop_todo.yml
|
||||
|
||||
AllCops:
|
||||
DisplayCopNames: true
|
||||
DisplayStyleGuide: true
|
||||
Exclude:
|
||||
- 'vendor/**/*'
|
||||
- 'gemfiles/**/*'
|
||||
|
||||
Metrics/LineLength:
|
||||
Enabled: false
|
||||
|
||||
@@ -61,9 +54,3 @@ Style/RegexpLiteral:
|
||||
Style/MutableConstant:
|
||||
Enabled: false
|
||||
|
||||
# "Use idx.positive? instead of idx > 0."
|
||||
Style/NumericPredicate:
|
||||
Enabled: false
|
||||
|
||||
Style/SafeNavigation:
|
||||
Enabled: false
|
||||
@@ -1,11 +1,20 @@
|
||||
# This configuration was generated by
|
||||
# `rubocop --auto-gen-config`
|
||||
# on 2016-09-30 23:56:15 +0200 using RuboCop version 0.43.0.
|
||||
# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
|
||||
# The point is for the user to remove these configuration records
|
||||
# one by one as the offenses are removed from the code base.
|
||||
# Note that changes in the inspected code, or installation of new
|
||||
# versions of RuboCop, may require this file to be generated again.
|
||||
|
||||
# Offense count: 1
|
||||
Lint/ImplicitStringConcatenation:
|
||||
Exclude:
|
||||
- 'lib/github_changelog_generator/parser.rb'
|
||||
|
||||
# Offense count: 14
|
||||
Metrics/AbcSize:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 1
|
||||
Metrics/CyclomaticComplexity:
|
||||
Max: 7
|
||||
@@ -13,3 +22,30 @@ Metrics/CyclomaticComplexity:
|
||||
# Offense count: 2
|
||||
Metrics/PerceivedComplexity:
|
||||
Max: 8
|
||||
|
||||
# Offense count: 1
|
||||
Style/AccessorMethodName:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 10
|
||||
Style/Documentation:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 1
|
||||
# Configuration parameters: MinBodyLength.
|
||||
Style/GuardClause:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 2
|
||||
# Cop supports --auto-correct.
|
||||
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
||||
# SupportedStyles: skip_modifier_ifs, always
|
||||
Style/Next:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 3
|
||||
# Cop supports --auto-correct.
|
||||
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
|
||||
# SupportedStyles: slashes, percent_r, mixed
|
||||
Style/RegexpLiteral:
|
||||
Enabled: false
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
2.3.1
|
||||
33
.travis.yml
33
.travis.yml
@@ -1,30 +1,23 @@
|
||||
language: ruby
|
||||
cache:
|
||||
- bundler
|
||||
language: ruby
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem install bundler
|
||||
rvm:
|
||||
- 2.1
|
||||
script: bundle exec rake checks
|
||||
matrix:
|
||||
include:
|
||||
- rvm: 2.2.2
|
||||
install: true # This skips 'bundle install'
|
||||
script: gem build github_changelog_generator && gem install *.gem
|
||||
- rvm: 2.2.2
|
||||
install: true # This skips 'bundle install'
|
||||
script: gem build github_changelog_generator && bundle install
|
||||
gemfile: spec/install-gem-in-bundler.gemfile
|
||||
- rvm: 2.1
|
||||
gemfile: gemfiles/Gemfile.2_1
|
||||
- rvm: 2.3.1
|
||||
gemfile: gemfiles/Gemfile.2_3_1
|
||||
- rvm: 2.4.0-preview2
|
||||
gemfile: gemfiles/Gemfile.2_4_0
|
||||
- rvm: jruby-9.1.5.0
|
||||
jdk: oraclejdk8
|
||||
gemfile: gemfiles/Gemfile.jruby-9.1.5.0
|
||||
env:
|
||||
- JRUBY_OPTS=--debug
|
||||
|
||||
# Test install on clean system
|
||||
- install: true
|
||||
script:
|
||||
- gem build github_changelog_generator
|
||||
- gem install *.gem
|
||||
- install: true
|
||||
script:
|
||||
- gem build github_changelog_generator
|
||||
- bundle install --gemfile spec/install-gem-in-bundler.gemfile
|
||||
notifications:
|
||||
email:
|
||||
recipients:
|
||||
|
||||
25
CHANGELOG.md
25
CHANGELOG.md
@@ -1,30 +1,5 @@
|
||||
# Change Log
|
||||
|
||||
## [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)
|
||||
|
||||
|
||||
25
Gemfile
25
Gemfile
@@ -1,30 +1,15 @@
|
||||
# frozen_string_literal: true
|
||||
source "https://rubygems.org"
|
||||
|
||||
gemspec
|
||||
|
||||
group :development, :test do
|
||||
group :test do
|
||||
gem "rake"
|
||||
gem "bundler"
|
||||
gem "overcommit", ">= 0.31"
|
||||
gem "rubocop", ">= 0.43"
|
||||
end
|
||||
|
||||
group :development do
|
||||
gem "bump"
|
||||
end
|
||||
|
||||
group :test do
|
||||
gem "vcr"
|
||||
gem "multi_json"
|
||||
gem "webmock"
|
||||
gem "rubocop"
|
||||
gem "overcommit"
|
||||
gem "coveralls", "~>0.8", require: false
|
||||
gem "simplecov", "~>0.10", require: false
|
||||
gem "codeclimate-test-reporter", "~>0.4"
|
||||
if RUBY_VERSION > "2"
|
||||
gem "json", "~> 2.0", ">= 2.0.2"
|
||||
else
|
||||
gem "json"
|
||||
end
|
||||
gem "rspec", "< 4"
|
||||
# JSON 2.0.1 is ruby 2.0+
|
||||
gem "json", "< 2.0"
|
||||
end
|
||||
|
||||
108
Gemfile.lock
Normal file
108
Gemfile.lock
Normal file
@@ -0,0 +1,108 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
github_changelog_generator (1.13.1)
|
||||
colorize (>= 0.7)
|
||||
github_api (>= 0.12)
|
||||
rake (>= 10.0)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.4.0)
|
||||
ast (2.3.0)
|
||||
childprocess (0.5.9)
|
||||
ffi (~> 1.0, >= 1.0.11)
|
||||
codeclimate-test-reporter (0.6.0)
|
||||
simplecov (>= 0.7.1, < 1.0.0)
|
||||
colorize (0.8.1)
|
||||
coveralls (0.8.14)
|
||||
json (>= 1.8, < 3)
|
||||
simplecov (~> 0.12.0)
|
||||
term-ansicolor (~> 1.3)
|
||||
thor (~> 0.19.1)
|
||||
tins (~> 1.6.0)
|
||||
descendants_tracker (0.0.4)
|
||||
thread_safe (~> 0.3, >= 0.3.1)
|
||||
diff-lcs (1.2.5)
|
||||
docile (1.1.5)
|
||||
faraday (0.9.2)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
ffi (1.9.14)
|
||||
github_api (0.14.4)
|
||||
addressable (~> 2.4.0)
|
||||
descendants_tracker (~> 0.0.4)
|
||||
faraday (~> 0.8, < 0.10)
|
||||
hashie (>= 3.4)
|
||||
oauth2 (~> 1.0.0)
|
||||
hashie (3.4.4)
|
||||
iniparse (1.4.2)
|
||||
json (1.8.3)
|
||||
jwt (1.5.4)
|
||||
multi_json (1.12.1)
|
||||
multi_xml (0.5.5)
|
||||
multipart-post (2.0.0)
|
||||
oauth2 (1.0.0)
|
||||
faraday (>= 0.8, < 0.10)
|
||||
jwt (~> 1.0)
|
||||
multi_json (~> 1.3)
|
||||
multi_xml (~> 0.5)
|
||||
rack (~> 1.2)
|
||||
overcommit (0.34.2)
|
||||
childprocess (~> 0.5.8)
|
||||
iniparse (~> 1.4)
|
||||
parser (2.3.1.2)
|
||||
ast (~> 2.2)
|
||||
powerpack (0.1.1)
|
||||
rack (1.6.4)
|
||||
rainbow (2.1.0)
|
||||
rake (11.2.2)
|
||||
rspec (3.5.0)
|
||||
rspec-core (~> 3.5.0)
|
||||
rspec-expectations (~> 3.5.0)
|
||||
rspec-mocks (~> 3.5.0)
|
||||
rspec-core (3.5.1)
|
||||
rspec-support (~> 3.5.0)
|
||||
rspec-expectations (3.5.0)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.5.0)
|
||||
rspec-mocks (3.5.0)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.5.0)
|
||||
rspec-support (3.5.0)
|
||||
rubocop (0.41.2)
|
||||
parser (>= 2.3.1.1, < 3.0)
|
||||
powerpack (~> 0.1)
|
||||
rainbow (>= 1.99.1, < 3.0)
|
||||
ruby-progressbar (~> 1.7)
|
||||
unicode-display_width (~> 1.0, >= 1.0.1)
|
||||
ruby-progressbar (1.8.1)
|
||||
simplecov (0.12.0)
|
||||
docile (~> 1.1.0)
|
||||
json (>= 1.8, < 3)
|
||||
simplecov-html (~> 0.10.0)
|
||||
simplecov-html (0.10.0)
|
||||
term-ansicolor (1.3.2)
|
||||
tins (~> 1.0)
|
||||
thor (0.19.1)
|
||||
thread_safe (0.3.5)
|
||||
tins (1.6.0)
|
||||
unicode-display_width (1.1.0)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
bundler
|
||||
codeclimate-test-reporter (~> 0.4)
|
||||
coveralls (~> 0.8)
|
||||
github_changelog_generator!
|
||||
json (< 2.0)
|
||||
overcommit
|
||||
rake
|
||||
rspec (>= 3.2)
|
||||
rubocop
|
||||
simplecov (~> 0.10)
|
||||
|
||||
BUNDLED WITH
|
||||
1.12.5
|
||||
32
README.md
32
README.md
@@ -4,7 +4,6 @@
|
||||
[](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://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
GitHub Changelog Generator 
|
||||
==================
|
||||
@@ -24,7 +23,7 @@ GitHub Changelog Generator 
|
||||
|
||||
### Changelog generation has never been so easy
|
||||
|
||||
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
|
||||
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
|
||||
|
||||
Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
|
||||
|
||||
@@ -37,9 +36,7 @@ Because software tools are for people. If you don’t care, why are you contribu
|
||||
|
||||
## Installation
|
||||
|
||||
gem install github_changelog_generator
|
||||
|
||||
See also Troubleshooting.
|
||||
[sudo] gem install github_changelog_generator
|
||||
|
||||
## Output example
|
||||
|
||||
@@ -226,31 +223,6 @@ If you're seeing this warning, please do the following:
|
||||
1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
|
||||
2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
||||
|
||||
- ***My Ruby version is very old, can I use this?***
|
||||
|
||||
When your Ruby is old, and you don't want to upgrade, and you want to
|
||||
control which libraries you use, you can use Bundler.
|
||||
|
||||
In a Gemfile, perhaps in a non-deployed `:development` group, add this
|
||||
gem:
|
||||
|
||||
```ruby
|
||||
group :development do
|
||||
gem 'github_changelog_generator', require: false
|
||||
end
|
||||
```
|
||||
|
||||
Then you can keep back dependencies like rack, which currently is only
|
||||
compatible with Ruby >= 2.2.2. So, use an older version for your app by
|
||||
adding a line like this to the Gemfile:
|
||||
|
||||
```
|
||||
gem 'rack', '~> 1.6'
|
||||
```
|
||||
|
||||
This way, you can keep on using github_changelog_generator, even if you
|
||||
can't get the latest version of Ruby installed.
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Create an issue and describe your idea
|
||||
|
||||
3
Rakefile
3
Rakefile
@@ -1,4 +1,3 @@
|
||||
# frozen_string_literal: true
|
||||
require "bundler"
|
||||
require "bundler/gem_tasks"
|
||||
require "rubocop/rake_task"
|
||||
@@ -37,4 +36,4 @@ task :copy_man_page_to_manpath do |_t|
|
||||
end
|
||||
|
||||
task checks: [:rubocop, :rspec]
|
||||
task default: [:rubocop, :rspec]
|
||||
task default: [:copy_man_page_to_manpath]
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
#! /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
|
||||
# frozen_string_literal: true
|
||||
|
||||
require_relative "../lib/github_changelog_generator"
|
||||
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
notify:
|
||||
webhooks:
|
||||
# A list of hook hashes, containing the url field
|
||||
# gitter hook
|
||||
- url: https://webhooks.gitter.im/e/2d81eb1ae7695fdc82c4
|
||||
- url: https://webhooks.gitter.im/e/3ec6a35fad7e9991058e
|
||||
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
|
||||
gem 'rack', '~> 1.6'
|
||||
gem 'activesupport', '~> 4'
|
||||
@@ -1,3 +0,0 @@
|
||||
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
|
||||
gem 'rack', '>= 2'
|
||||
gem 'activesupport', '>= 4'
|
||||
@@ -1,3 +0,0 @@
|
||||
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
|
||||
gem 'rack', '>= 2'
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
|
||||
gem 'rack', '>= 2'
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
# coding: utf-8
|
||||
# frozen_string_literal: true
|
||||
lib = File.expand_path("../lib", __FILE__)
|
||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||
require "github_changelog_generator/version"
|
||||
@@ -25,9 +24,11 @@ Gem::Specification.new do |spec|
|
||||
spec.require_paths = ["lib"]
|
||||
|
||||
spec.add_runtime_dependency "rake", ">= 10.0"
|
||||
spec.add_runtime_dependency "rainbow", ">= 2.1"
|
||||
spec.add_runtime_dependency("octokit", ["~> 4.0"])
|
||||
spec.add_runtime_dependency("faraday-http-cache")
|
||||
spec.add_runtime_dependency("activesupport")
|
||||
spec.add_runtime_dependency("retriable", ["~> 2.1"])
|
||||
spec.add_runtime_dependency "github_api", ">= 0.12"
|
||||
spec.add_runtime_dependency "colorize", ">= 0.7"
|
||||
|
||||
spec.add_development_dependency "overcommit", ">= 0.31"
|
||||
spec.add_development_dependency "rspec", ">= 3.2"
|
||||
spec.add_development_dependency "bundler", ">= 1.7"
|
||||
spec.add_development_dependency "rubocop", ">= 0.31"
|
||||
end
|
||||
|
||||
58
lib/CHANGELOG.md
Normal file
58
lib/CHANGELOG.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# 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: | ||||