Compare commits
62 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d081130e3e | ||
|
|
016f5e690c | ||
|
|
925012049f | ||
|
|
b9593f7c70 | ||
|
|
e6d80b0cf0 | ||
|
|
a4a6e6dedb | ||
|
|
f215694ffb | ||
|
|
68a045da22 | ||
|
|
e274f9992a | ||
|
|
4de98a7d16 | ||
|
|
d21651776c | ||
|
|
77d86b1e91 | ||
|
|
cb4533abf7 | ||
|
|
df47a88b47 | ||
|
|
8c6b783d6c | ||
|
|
9e84bfbabf | ||
|
|
57b33ae6b9 | ||
|
|
36346b5fc6 | ||
|
|
f24780eb19 | ||
|
|
f77f90a750 | ||
|
|
d33994d595 | ||
|
|
b6f86a8cb6 | ||
|
|
5cd87a44a6 | ||
|
|
243f0cf292 | ||
|
|
fee976df22 | ||
|
|
e735683eaf | ||
|
|
4f21ae7768 | ||
|
|
c480075e8e | ||
|
|
268a8f39b6 | ||
|
|
1fa1cccd2a | ||
|
|
adab012de4 | ||
|
|
e114901157 | ||
|
|
6c6116381b | ||
|
|
f527cfff67 | ||
|
|
92496f7c72 | ||
|
|
082210f49b | ||
|
|
dc67089c21 | ||
|
|
865ddbcacd | ||
|
|
9f2fb5f56c | ||
|
|
44ce94d7a8 | ||
|
|
67ea3159cd | ||
|
|
80a5fdef0c | ||
|
|
f7e9199841 | ||
|
|
19eb03c54e | ||
|
|
22d1657fd4 | ||
|
|
6fdcc0c61d | ||
|
|
dac3be9f7d | ||
|
|
9f1537ab34 | ||
|
|
9055792021 | ||
|
|
9720c96b8c | ||
|
|
8906fe5022 | ||
|
|
a415010e86 | ||
|
|
67fbb04b31 | ||
|
|
ff6115247e | ||
|
|
a0cf2f54ee | ||
|
|
0c8010d854 | ||
|
|
9b46d56a9e | ||
|
|
c3867a89f1 | ||
|
|
5cc3a7c8fd | ||
|
|
160cda50bc | ||
|
|
8e090022f0 | ||
|
|
a94834d57e |
@@ -1,13 +1,13 @@
|
||||
# This configuration was generated by `rubocop --auto-gen-config`
|
||||
# on 2015-05-26 16:00:55 +0300 using RuboCop version 0.31.0.
|
||||
# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
|
||||
# The point is for the user to remove these configuration records
|
||||
# one by one as the offenses are removed from the code base.
|
||||
# Note that changes in the inspected code, or installation of new
|
||||
# versions of RuboCop, may require this file to be generated again.
|
||||
|
||||
# Offense count: 14
|
||||
# Offense count: 13
|
||||
Metrics/AbcSize:
|
||||
Max: 59
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 1
|
||||
Metrics/CyclomaticComplexity:
|
||||
@@ -21,7 +21,7 @@ Metrics/PerceivedComplexity:
|
||||
Style/AccessorMethodName:
|
||||
Enabled: false
|
||||
|
||||
# Offense count: 8
|
||||
# Offense count: 10
|
||||
Style/Documentation:
|
||||
Enabled: false
|
||||
|
||||
|
||||
58
CHANGELOG.md
58
CHANGELOG.md
@@ -1,5 +1,59 @@
|
||||
# Change Log
|
||||
|
||||
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250)
|
||||
|
||||
## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Ability to specify custom section header [\#241](https://github.com/skywinder/github-changelog-generator/issues/241)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249)
|
||||
|
||||
## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Issues with any label except "bug", "enhancement" should not be excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240)
|
||||
|
||||
- Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246)
|
||||
|
||||
- Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245)
|
||||
|
||||
## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.1...1.5.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
|
||||
|
||||
- Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
|
||||
|
||||
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
|
||||
|
||||
- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1)
|
||||
@@ -40,12 +94,12 @@
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
||||
|
||||
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- 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))
|
||||
|
||||
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
||||
|
||||
15
Gemfile
15
Gemfile
@@ -1,14 +1,11 @@
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "rake", ">=10.4.2"
|
||||
|
||||
gem "github_api", ">=0.12.3"
|
||||
gem "colorize", ">=0.7.7"
|
||||
gemspec
|
||||
|
||||
group :test do
|
||||
gem "rspec"
|
||||
gem "rubocop"
|
||||
gem "coveralls", require: false
|
||||
gem "simplecov", require: false
|
||||
gem "codeclimate-test-reporter"
|
||||
gem "rspec", "~>3.2"
|
||||
gem "rubocop", "~>0.31"
|
||||
gem "coveralls", "~>0.8", require: false
|
||||
gem "simplecov", "~>0.10", require: false
|
||||
gem "codeclimate-test-reporter", "~>0.4"
|
||||
end
|
||||
|
||||
73
Gemfile.lock
73
Gemfile.lock
@@ -1,14 +1,21 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
github_changelog_generator (1.6.2)
|
||||
colorize (~> 0.7)
|
||||
github_api (~> 0.12)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.3.8)
|
||||
ast (2.0.0)
|
||||
astrolabe (1.3.0)
|
||||
parser (>= 2.2.0.pre.3, < 3.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.1)
|
||||
coveralls (0.8.2)
|
||||
json (~> 1.8)
|
||||
rest-client (>= 1.6.8, < 2)
|
||||
simplecov (~> 0.10.0)
|
||||
@@ -30,14 +37,14 @@ GEM
|
||||
multi_json (>= 1.7.5, < 2.0)
|
||||
nokogiri (~> 1.6.3)
|
||||
oauth2
|
||||
hashie (3.4.1)
|
||||
hashie (3.4.2)
|
||||
http-cookie (1.0.2)
|
||||
domain_name (~> 0.5)
|
||||
json (1.8.2)
|
||||
jwt (1.5.0)
|
||||
mime-types (2.5)
|
||||
json (1.8.3)
|
||||
jwt (1.5.1)
|
||||
mime-types (2.6.1)
|
||||
mini_portile (0.6.2)
|
||||
multi_json (1.11.0)
|
||||
multi_json (1.11.2)
|
||||
multi_xml (0.5.5)
|
||||
multipart-post (2.0.0)
|
||||
netrc (0.10.3)
|
||||
@@ -49,32 +56,32 @@ GEM
|
||||
multi_json (~> 1.3)
|
||||
multi_xml (~> 0.5)
|
||||
rack (~> 1.2)
|
||||
parser (2.2.2.2)
|
||||
parser (2.2.2.6)
|
||||
ast (>= 1.1, < 3.0)
|
||||
powerpack (0.1.1)
|
||||
rack (1.6.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.2.0)
|
||||
rspec-core (~> 3.2.0)
|
||||
rspec-expectations (~> 3.2.0)
|
||||
rspec-mocks (~> 3.2.0)
|
||||
rspec-core (3.2.3)
|
||||
rspec-support (~> 3.2.0)
|
||||
rspec-expectations (3.2.1)
|
||||
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.2.0)
|
||||
rspec-mocks (3.2.1)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-mocks (3.3.2)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.2.0)
|
||||
rspec-support (3.2.2)
|
||||
rubocop (0.31.0)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-support (3.3.0)
|
||||
rubocop (0.32.1)
|
||||
astrolabe (~> 1.3)
|
||||
parser (>= 2.2.2.1, < 3.0)
|
||||
parser (>= 2.2.2.5, < 3.0)
|
||||
powerpack (~> 0.1)
|
||||
rainbow (>= 1.99.1, < 3.0)
|
||||
ruby-progressbar (~> 1.4)
|
||||
@@ -84,11 +91,11 @@ GEM
|
||||
json (~> 1.8)
|
||||
simplecov-html (~> 0.10.0)
|
||||
simplecov-html (0.10.0)
|
||||
term-ansicolor (1.3.0)
|
||||
term-ansicolor (1.3.2)
|
||||
tins (~> 1.0)
|
||||
thor (0.19.1)
|
||||
thread_safe (0.3.5)
|
||||
tins (1.5.1)
|
||||
tins (1.5.4)
|
||||
unf (0.1.4)
|
||||
unf_ext
|
||||
unf_ext (0.0.7.1)
|
||||
@@ -97,11 +104,11 @@ PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
codeclimate-test-reporter
|
||||
colorize (>= 0.7.7)
|
||||
coveralls
|
||||
github_api (>= 0.12.3)
|
||||
rake (>= 10.4.2)
|
||||
rspec
|
||||
rubocop
|
||||
simplecov
|
||||
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)
|
||||
|
||||
37
README.md
37
README.md
@@ -80,44 +80,15 @@ Because software tools are for people. If you don’t care, why are you contribu
|
||||
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||
|
||||
### Params
|
||||
Type `github_changelog_generator --help` for detailed usage.
|
||||
|
||||
Usage: github_changelog_generator [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
|
||||
--[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
|
||||
--unreleased-only Generate log from unreleased closed issues only.
|
||||
--[no-]unreleased Add to log unreleased closed issues. Default is true
|
||||
--unreleased-label [label] Add to log unreleased closed issues. Default is true
|
||||
--[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. Default is 'bug,enhancement'
|
||||
--exclude-labels x,y,z Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
||||
--between-tags x,y,z Change log will be filled only between specified tags
|
||||
--exclude-tags x,y,z Change log will be exclude specified tags
|
||||
--max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited
|
||||
--github-site [URL] The Enterprise Github site on which your project is hosted.
|
||||
--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.
|
||||
--[no-]verbose Run verbosely. Default is true
|
||||
-v, --version Print version number
|
||||
-h, --help Displays Help
|
||||
Type `github_changelog_generator --help` for details.
|
||||
|
||||
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 token
|
||||
|
||||
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
||||
|
||||
**You can easily [generate it here](https://github.com/settings/tokens)**.
|
||||
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
|
||||
|
||||
And:
|
||||
|
||||
@@ -134,7 +105,7 @@ So, if you got error like this:
|
||||
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||
|
||||
##Features and advantages of this project
|
||||
- Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
|
||||
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
|
||||
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
||||
- **GitHub Enterprise support** via command line options! :factory:
|
||||
- Flexible format **customisation**:
|
||||
|
||||
@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
|
||||
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||
spec.require_paths = ["lib"]
|
||||
|
||||
spec.add_development_dependency "bundler", "~> 1.7"
|
||||
spec.add_development_dependency "rake", "~> 10.0"
|
||||
|
||||
spec.add_runtime_dependency("github_api", ["~> 0.12"])
|
||||
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
||||
|
||||
# Development only
|
||||
spec.add_development_dependency "bundler", "~> 1.7"
|
||||
spec.add_development_dependency "rake", "~> 10.0"
|
||||
end
|
||||
|
||||
@@ -1,7 +1,30 @@
|
||||
# Change Log
|
||||
|
||||
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
|
||||
## [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:**
|
||||
@@ -13,7 +36,6 @@
|
||||
- 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:**
|
||||
@@ -21,7 +43,6 @@
|
||||
- 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:**
|
||||
@@ -31,5 +52,4 @@
|
||||
## [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)*
|
||||
@@ -5,6 +5,7 @@ require "json"
|
||||
require "colorize"
|
||||
require "benchmark"
|
||||
|
||||
require_relative "github_changelog_generator/helper"
|
||||
require_relative "github_changelog_generator/parser"
|
||||
require_relative "github_changelog_generator/generator/generator"
|
||||
require_relative "github_changelog_generator/version"
|
||||
|
||||
@@ -1,11 +1,10 @@
|
||||
require "logger"
|
||||
|
||||
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"
|
||||
@@ -16,16 +15,9 @@ module GitHubChangelogGenerator
|
||||
|
||||
def initialize(options = {})
|
||||
@options = options || {}
|
||||
|
||||
@logger = Logger.new(STDOUT)
|
||||
@logger.formatter = proc do |_severity, _datetime, _progname, msg|
|
||||
"#{msg}\n"
|
||||
end
|
||||
|
||||
@user = @options[:user]
|
||||
@project = @options[:project]
|
||||
@github_token = fetch_github_token
|
||||
@tag_times_hash = {}
|
||||
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?
|
||||
@@ -41,7 +33,7 @@ module GitHubChangelogGenerator
|
||||
def fetch_github_token
|
||||
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
|
||||
|
||||
@logger.warn NO_TOKEN_PROVIDED.yellow unless env_var
|
||||
Helper.log.warn NO_TOKEN_PROVIDED.yellow unless env_var
|
||||
|
||||
env_var
|
||||
end
|
||||
@@ -51,27 +43,28 @@ module GitHubChangelogGenerator
|
||||
def get_all_tags
|
||||
print "Fetching tags...\r" if @options[:verbose]
|
||||
|
||||
tags = []
|
||||
|
||||
check_github_response { github_fetch_tags(tags) }
|
||||
|
||||
tags
|
||||
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
|
||||
@logger.error e.body.red
|
||||
Helper.log.error e.body.red
|
||||
abort "Error: wrong GitHub token"
|
||||
rescue Github::Error::Forbidden => e
|
||||
@logger.warn e.body.red
|
||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
Helper.log.warn e.body.red
|
||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
end
|
||||
value
|
||||
end
|
||||
|
||||
def github_fetch_tags(tags)
|
||||
# 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
|
||||
@@ -83,11 +76,12 @@ module GitHubChangelogGenerator
|
||||
print_empty_line
|
||||
|
||||
if tags.count == 0
|
||||
@logger.warn "Warning: Can't find any tags in repo.\
|
||||
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
|
||||
@logger.info "Found #{tags.count} tags"
|
||||
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
|
||||
@@ -112,10 +106,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
||||
end
|
||||
print_empty_line
|
||||
@logger.info "Received issues: #{issues.count}"
|
||||
Helper.log.info "Received issues: #{issues.count}"
|
||||
|
||||
rescue
|
||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
end
|
||||
|
||||
# separate arrays of issues and pull requests:
|
||||
@@ -140,17 +134,20 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||
end
|
||||
print_empty_line
|
||||
rescue
|
||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
end
|
||||
|
||||
@logger.info "Fetching merged dates: #{pull_requests.count}"
|
||||
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
|
||||
@@ -169,10 +166,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||
obj = @github.issues.events.list user: @options[:user],
|
||||
repo: @options[:project],
|
||||
issue_number: issue["number"]
|
||||
issue[:events] = obj.body
|
||||
rescue
|
||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
end
|
||||
issue[:events] = obj.body
|
||||
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
|
||||
i += 1
|
||||
end
|
||||
@@ -184,32 +181,26 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||
# to clear line from prev print
|
||||
print_empty_line
|
||||
|
||||
@logger.info "Fetching events for issues and PR: #{i}"
|
||||
Helper.log.info "Fetching events for issues and PR: #{i}"
|
||||
end
|
||||
|
||||
# Try to find tag date in local hash.
|
||||
# Otherwise fFetch tag time and put it to local hash file.
|
||||
# @param [String] tag_name name of the tag
|
||||
# Fetch tag time from repo
|
||||
#
|
||||
# @param [Hash] tag
|
||||
# @return [Time] time of specified tag
|
||||
def get_time_of_tag(tag_name)
|
||||
fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
|
||||
|
||||
if @tag_times_hash[tag_name["name"]]
|
||||
return @tag_times_hash[tag_name["name"]]
|
||||
end
|
||||
|
||||
def fetch_date_of_tag(tag)
|
||||
begin
|
||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user],
|
||||
@options[:project],
|
||||
tag_name["commit"]["sha"]
|
||||
commit_data = @github.git_data.commits.get @options[:user],
|
||||
@options[:project],
|
||||
tag["commit"]["sha"]
|
||||
rescue
|
||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
end
|
||||
time_string = github_git_data_commits_get["committer"]["date"]
|
||||
@tag_times_hash[tag_name["name"]] = Time.parse(time_string)
|
||||
time_string = commit_data["committer"]["date"]
|
||||
Time.parse(time_string)
|
||||
end
|
||||
|
||||
# Fetch commit for specifed event
|
||||
# Fetch commit for specified event
|
||||
# @return [Hash]
|
||||
def fetch_commit(event)
|
||||
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
require "github_changelog_generator/fetcher"
|
||||
require_relative "../fetcher"
|
||||
require_relative "generator_generation"
|
||||
require_relative "generator_fetcher"
|
||||
require_relative "generator_processor"
|
||||
@@ -10,7 +10,7 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
|
||||
class Generator
|
||||
attr_accessor :options, :all_tags, :github
|
||||
attr_accessor :options, :filtered_tags, :github
|
||||
|
||||
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues
|
||||
#
|
||||
@@ -19,7 +19,7 @@ module GitHubChangelogGenerator
|
||||
# content = generator.compound_changelog
|
||||
def initialize(options = nil)
|
||||
@options = options || {}
|
||||
|
||||
@tag_times_hash = {}
|
||||
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
|
||||
end
|
||||
|
||||
@@ -41,7 +41,7 @@ module GitHubChangelogGenerator
|
||||
def encapsulate_string(string)
|
||||
string.gsub! '\\', '\\\\'
|
||||
|
||||
encpas_chars = %w(> * _ \( \) [ ] #)
|
||||
encpas_chars = %w(< > * _ \( \) [ ] #)
|
||||
encpas_chars.each do |char|
|
||||
string.gsub! char, "\\#{char}"
|
||||
end
|
||||
@@ -56,7 +56,7 @@ module GitHubChangelogGenerator
|
||||
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
||||
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
|
||||
# @return [String] Ready and parsed section
|
||||
def create_log(pull_requests, issues, newer_tag, older_tag_name = 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)
|
||||
|
||||
github_site = options[:github_site] || "https://github.com"
|
||||
@@ -104,12 +104,12 @@ module GitHubChangelogGenerator
|
||||
issues.each do |dict|
|
||||
added = false
|
||||
dict.labels.each do |label|
|
||||
if label.name == "bug"
|
||||
if @options[:bug_labels].include? label.name
|
||||
bugs_a.push dict
|
||||
added = true
|
||||
next
|
||||
end
|
||||
if label.name == "enhancement"
|
||||
if @options[:enhancement_labels].include? label.name
|
||||
enhancement_a.push dict
|
||||
added = true
|
||||
next
|
||||
|
||||
@@ -17,11 +17,11 @@ module GitHubChangelogGenerator
|
||||
# Async fetching tags:
|
||||
threads = []
|
||||
i = 0
|
||||
all = @all_tags.count
|
||||
@all_tags.each do |tag|
|
||||
all = @filtered_tags.count
|
||||
@filtered_tags.each do |tag|
|
||||
print " \r"
|
||||
threads << Thread.new do
|
||||
@fetcher.get_time_of_tag(tag)
|
||||
get_time_of_tag(tag)
|
||||
print "Fetching tags dates: #{i + 1}/#{all}\r" if @options[:verbose]
|
||||
i += 1
|
||||
end
|
||||
@@ -41,8 +41,8 @@ module GitHubChangelogGenerator
|
||||
threads << Thread.new { find_closed_date_by_commit(issue) }
|
||||
end
|
||||
threads.each(&:join)
|
||||
puts "Fetching closed dates for issues: Done!" if @options[:verbose]
|
||||
end
|
||||
puts "Fetching closed dates for issues: Done!" if @options[:verbose]
|
||||
end
|
||||
|
||||
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
|
||||
|
||||
@@ -5,12 +5,13 @@ module GitHubChangelogGenerator
|
||||
# @return [String] Generated change log file
|
||||
def compound_changelog
|
||||
fetch_and_filter_tags
|
||||
sort_tags_by_date(@filtered_tags)
|
||||
fetch_issues_and_pr
|
||||
|
||||
log = "# Change Log\n\n"
|
||||
log = "#{@options[:header]}\n\n"
|
||||
|
||||
if @options[:unreleased_only]
|
||||
log += generate_log_between_tags(all_tags[0], nil)
|
||||
log += generate_log_between_tags(filtered_tags[0], nil)
|
||||
else
|
||||
log += generate_log_for_all_tags
|
||||
end
|
||||
@@ -24,7 +25,7 @@ module GitHubChangelogGenerator
|
||||
tag1 = @options[:tag1]
|
||||
tag2 = @options[:tag2]
|
||||
tags_strings = []
|
||||
all_tags.each { |x| tags_strings.push(x["name"]) }
|
||||
filtered_tags.each { |x| tags_strings.push(x["name"]) }
|
||||
|
||||
if tags_strings.include?(tag1)
|
||||
if tags_strings.include?(tag2)
|
||||
@@ -53,8 +54,9 @@ module GitHubChangelogGenerator
|
||||
if issues.any?
|
||||
issues.each do |issue|
|
||||
merge_string = get_string_for_issue(issue)
|
||||
log += "- #{merge_string}\n\n"
|
||||
log += "- #{merge_string}\n"
|
||||
end
|
||||
log += "\n"
|
||||
end
|
||||
log
|
||||
end
|
||||
@@ -77,7 +79,7 @@ module GitHubChangelogGenerator
|
||||
if newer_tag_name.equal? @options[:unreleased_label]
|
||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
|
||||
else
|
||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
|
||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n"
|
||||
end
|
||||
|
||||
if @options[:compare_link] && older_tag_link
|
||||
@@ -101,7 +103,7 @@ module GitHubChangelogGenerator
|
||||
return ""
|
||||
end
|
||||
|
||||
create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
||||
create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
||||
end
|
||||
|
||||
# Apply all filters to issues and pull requests
|
||||
@@ -128,11 +130,11 @@ module GitHubChangelogGenerator
|
||||
|
||||
log = generate_unreleased_section
|
||||
|
||||
(1...all_tags.size).each do |index|
|
||||
log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
|
||||
(1...filtered_tags.size).each do |index|
|
||||
log += generate_log_between_tags(filtered_tags[index], filtered_tags[index - 1])
|
||||
end
|
||||
if @all_tags.count != 0
|
||||
log += generate_log_between_tags(nil, all_tags.last)
|
||||
if @filtered_tags.count != 0
|
||||
log += generate_log_between_tags(nil, filtered_tags.last)
|
||||
end
|
||||
|
||||
log
|
||||
@@ -141,7 +143,7 @@ module GitHubChangelogGenerator
|
||||
def generate_unreleased_section
|
||||
log = ""
|
||||
if @options[:unreleased]
|
||||
unreleased_log = generate_log_between_tags(all_tags[0], nil)
|
||||
unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
|
||||
log += unreleased_log if unreleased_log
|
||||
end
|
||||
log
|
||||
|
||||
@@ -36,7 +36,7 @@ module GitHubChangelogGenerator
|
||||
false
|
||||
else
|
||||
# check, that this milestone in tag list:
|
||||
milestone_is_tag = @all_tags.find do |tag|
|
||||
milestone_is_tag = @filtered_tags.find do |tag|
|
||||
tag.name == issue.milestone.title
|
||||
end
|
||||
|
||||
@@ -57,7 +57,7 @@ module GitHubChangelogGenerator
|
||||
true
|
||||
else
|
||||
# check, that this milestone in tag list:
|
||||
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
||||
@filtered_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -72,8 +72,8 @@ module GitHubChangelogGenerator
|
||||
# in case if not tags specified - return unchanged array
|
||||
return array if older_tag.nil? && newer_tag.nil?
|
||||
|
||||
newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
|
||||
older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
|
||||
newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
|
||||
older_tag_time = older_tag && get_time_of_tag(older_tag)
|
||||
|
||||
array.select do |req|
|
||||
if req[hash_key]
|
||||
|
||||
@@ -2,15 +2,34 @@ module GitHubChangelogGenerator
|
||||
class Generator
|
||||
# fetch, filter tags, fetch dates and sort them in time order
|
||||
def fetch_and_filter_tags
|
||||
@all_tags = get_filtered_tags(@fetcher.get_all_tags)
|
||||
@filtered_tags = get_filtered_tags(@fetcher.get_all_tags)
|
||||
fetch_tags_dates
|
||||
sort_tags_by_date
|
||||
end
|
||||
|
||||
# Sort all tags by date
|
||||
def sort_tags_by_date
|
||||
def sort_tags_by_date(tags)
|
||||
puts "Sorting tags..." if @options[:verbose]
|
||||
@all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
|
||||
tags.sort_by! do |x|
|
||||
get_time_of_tag(x)
|
||||
end.reverse!
|
||||
end
|
||||
|
||||
# Try to find tag date in local hash.
|
||||
# Otherwise fFetch tag time and put it to local hash file.
|
||||
# @param [Hash] tag_name name of the tag
|
||||
# @return [Time] time of specified tag
|
||||
def get_time_of_tag(tag_name)
|
||||
fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
|
||||
|
||||
name_of_tag = tag_name["name"]
|
||||
time_for_name = @tag_times_hash[name_of_tag]
|
||||
if !time_for_name.nil?
|
||||
time_for_name
|
||||
else
|
||||
time_string = @fetcher.fetch_date_of_tag tag_name
|
||||
@tag_times_hash[name_of_tag] = time_string
|
||||
time_string
|
||||
end
|
||||
end
|
||||
|
||||
# Detect link, name and time for specified tag.
|
||||
@@ -19,7 +38,7 @@ module GitHubChangelogGenerator
|
||||
# @return [Array] link, name and time of the tag
|
||||
def detect_link_tag_time(newer_tag)
|
||||
# if tag is nil - set current time
|
||||
newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.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 newer_tag.nil? && @options[:future_release]
|
||||
@@ -45,11 +64,11 @@ module GitHubChangelogGenerator
|
||||
filtered_tags = all_tags
|
||||
if @options[:between_tags]
|
||||
@options[:between_tags].each do |tag|
|
||||
unless all_tags.include? tag
|
||||
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
|
||||
unless all_tags.map(&:name).include? tag
|
||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
|
||||
end
|
||||
end
|
||||
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
|
||||
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag.name }
|
||||
end
|
||||
filtered_tags
|
||||
end
|
||||
@@ -58,11 +77,11 @@ module GitHubChangelogGenerator
|
||||
filtered_tags = all_tags
|
||||
if @options[:exclude_tags]
|
||||
@options[:exclude_tags].each do |tag|
|
||||
unless all_tags.include? tag
|
||||
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
|
||||
unless all_tags.map(&:name).include? tag
|
||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
|
||||
end
|
||||
end
|
||||
filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag }
|
||||
filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
|
||||
end
|
||||
filtered_tags
|
||||
end
|
||||
|
||||
37
lib/github_changelog_generator/helper.rb
Normal file
37
lib/github_changelog_generator/helper.rb
Normal file
@@ -0,0 +1,37 @@
|
||||
require "logger"
|
||||
module GitHubChangelogGenerator
|
||||
module Helper
|
||||
# @return true if the currently running program is a unit test
|
||||
def self.test?
|
||||
defined?SpecHelper
|
||||
end
|
||||
|
||||
if test?
|
||||
@log ||= Logger.new(nil) # don't show any logs when running tests
|
||||
else
|
||||
@log ||= Logger.new(STDOUT)
|
||||
end
|
||||
@log.formatter = proc do |severity, _datetime, _progname, msg|
|
||||
string = "#{msg}\n"
|
||||
|
||||
if severity == "DEBUG"
|
||||
string = string.magenta
|
||||
elsif severity == "INFO"
|
||||
string = string.white
|
||||
elsif severity == "WARN"
|
||||
string = string.yellow
|
||||
elsif severity == "ERROR"
|
||||
string = string.red
|
||||
elsif severity == "FATAL"
|
||||
string = string.red.bold
|
||||
end
|
||||
|
||||
string
|
||||
end
|
||||
|
||||
# Logging happens using this method
|
||||
class << self
|
||||
attr_reader :log
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -2,7 +2,7 @@
|
||||
require "optparse"
|
||||
require "pp"
|
||||
require_relative "version"
|
||||
|
||||
require_relative "helper"
|
||||
module GitHubChangelogGenerator
|
||||
class Parser
|
||||
# parse options with optparse
|
||||
@@ -13,7 +13,9 @@ module GitHubChangelogGenerator
|
||||
|
||||
parser.parse!
|
||||
|
||||
detect_user_and_project(options)
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
detect_user_and_project(options)
|
||||
end
|
||||
|
||||
if !options[:user] || !options[:project]
|
||||
puts parser.banner
|
||||
@@ -21,7 +23,7 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
|
||||
if options[:verbose]
|
||||
puts "Performing task with options:"
|
||||
Helper.log.info "Performing task with options:"
|
||||
pp options
|
||||
puts ""
|
||||
end
|
||||
@@ -48,6 +50,21 @@ module GitHubChangelogGenerator
|
||||
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
||||
options[:output] = last
|
||||
end
|
||||
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
|
||||
options[:bug_prefix] = v
|
||||
end
|
||||
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
|
||||
options[:enhancement_prefix] = v
|
||||
end
|
||||
opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
|
||||
options[:issue_prefix] = v
|
||||
end
|
||||
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
|
||||
options[:header] = v
|
||||
end
|
||||
opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
|
||||
options[:merge_prefix] = v
|
||||
end
|
||||
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
|
||||
options[:issues] = v
|
||||
end
|
||||
@@ -78,12 +95,18 @@ module GitHubChangelogGenerator
|
||||
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
|
||||
options[:compare_link] = v
|
||||
end
|
||||
opts.on("--include-labels x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
|
||||
opts.on("--include-labels x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
|
||||
options[:include_labels] = list
|
||||
end
|
||||
opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
|
||||
options[:exclude_labels] = list
|
||||
end
|
||||
opts.on("--bug-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
|
||||
options[:bug_labels] = list
|
||||
end
|
||||
opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
|
||||
options[:enhancement_labels] = list
|
||||
end
|
||||
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
|
||||
options[:between_tags] = list
|
||||
end
|
||||
@@ -136,11 +159,13 @@ module GitHubChangelogGenerator
|
||||
unreleased: true,
|
||||
unreleased_label: "Unreleased",
|
||||
compare_link: true,
|
||||
include_labels: %w(bug enhancement),
|
||||
exclude_labels: %w(duplicate question invalid wontfix),
|
||||
enhancement_labels: %w(enhancement Enhancement),
|
||||
bug_labels: %w(bug Bug),
|
||||
exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
|
||||
max_issues: nil,
|
||||
simple_list: false,
|
||||
verbose: true,
|
||||
header: "# Change Log",
|
||||
merge_prefix: "**Merged pull requests:**",
|
||||
issue_prefix: "**Closed issues:**",
|
||||
bug_prefix: "**Fixed bugs:**",
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
module GitHubChangelogGenerator
|
||||
VERSION = "1.5.0"
|
||||
VERSION = "1.7.0"
|
||||
end
|
||||
|
||||
@@ -19,6 +19,10 @@ require "codeclimate-test-reporter"
|
||||
require "simplecov"
|
||||
require "coveralls"
|
||||
|
||||
# This module is only used to check the environment is currently a testing env
|
||||
module SpecHelper
|
||||
end
|
||||
|
||||
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
||||
Coveralls::SimpleCov::Formatter,
|
||||
SimpleCov::Formatter::HTMLFormatter,
|
||||
|
||||
@@ -52,7 +52,7 @@ describe GitHubChangelogGenerator::Fetcher do
|
||||
@fetcher = GitHubChangelogGenerator::Fetcher.new(options)
|
||||
end
|
||||
it "should raise Unauthorized error" do
|
||||
expect { @fetcher.github_fetch_tags [] }.to raise_error Github::Error::Unauthorized
|
||||
expect { @fetcher.github_fetch_tags }.to raise_error Github::Error::Unauthorized
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,3 +1,18 @@
|
||||
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 "#filter_between_tags" do
|
||||
context "when between_tags nil" do
|
||||
@@ -6,20 +21,20 @@ describe GitHubChangelogGenerator::Generator do
|
||||
end
|
||||
|
||||
subject do
|
||||
@generator.get_filtered_tags(%w(1 2 3))
|
||||
@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(%w(1 2 3)) }
|
||||
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(%w(1 2 3))
|
||||
@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(%w(1 2 3)) }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||
end
|
||||
|
||||
context "when between_tags filled with correct values" do
|
||||
@@ -27,10 +42,10 @@ describe GitHubChangelogGenerator::Generator do
|
||||
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
|
||||
end
|
||||
subject do
|
||||
@generator.get_filtered_tags(%w(1 2 3))
|
||||
@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(%w(1 2)) }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
||||
end
|
||||
|
||||
context "when between_tags filled with invalid values" do
|
||||
@@ -39,31 +54,98 @@ describe GitHubChangelogGenerator::Generator do
|
||||
end
|
||||
|
||||
subject do
|
||||
@generator.get_filtered_tags(%w(1 2 3))
|
||||
@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(%w(1)) }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||
end
|
||||
end
|
||||
|
||||
describe "#get_filtered_tags" do
|
||||
subject { generator.get_filtered_tags(%w(1 2 3 4 5)) }
|
||||
# before { generator.get_filtered_tags(%w(1 2 3 4 5)) }
|
||||
subject do
|
||||
generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3 4 5)))
|
||||
end
|
||||
|
||||
context "with excluded and between tags" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(%w(1 3)) }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 3))) }
|
||||
end
|
||||
end
|
||||
|
||||
describe "#filter_excluded_tags" do
|
||||
subject { generator.filter_excluded_tags(%w(1 2 3)) }
|
||||
subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
|
||||
|
||||
context "with valid excluded tags" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(%w(1 2)) }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
||||
end
|
||||
|
||||
context "with invalid excluded tags" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||
end
|
||||
end
|
||||
|
||||
describe "#get_time_of_tag" do
|
||||
current_time = Time.now
|
||||
before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
|
||||
context "run with nil parameter" do
|
||||
it "should raise ChangelogGeneratorError" do
|
||||
expect { @generator.get_time_of_tag nil }.to raise_error(GitHubChangelogGenerator::ChangelogGeneratorError)
|
||||
end
|
||||
end
|
||||
context "fetch already filled tag" do
|
||||
before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
|
||||
subject { @generator.get_time_of_tag tag_mash_with_name("valid_tag") }
|
||||
it { is_expected.to be_a_kind_of(Time) }
|
||||
it { is_expected.to eq(current_time) }
|
||||
end
|
||||
context "fetch not filled tag" do
|
||||
before do
|
||||
mock = double("fake fetcher")
|
||||
allow(mock).to receive_messages(fetch_date_of_tag: current_time)
|
||||
@generator.instance_variable_set :@fetcher, mock
|
||||
end
|
||||
subject do
|
||||
of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
|
||||
of_tag
|
||||
end
|
||||
it { is_expected.to be_a_kind_of(Time) }
|
||||
it { is_expected.to eq(current_time) }
|
||||
end
|
||||
end
|
||||
|
||||
describe "#sort_tags_by_date" do
|
||||
time1 = Time.now
|
||||
time2 = Time.now
|
||||
time3 = Time.now
|
||||
before(:all) do
|
||||
@generator = GitHubChangelogGenerator::Generator.new
|
||||
end
|
||||
context "sort unsorted tags" do
|
||||
tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
|
||||
before do
|
||||
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
||||
end
|
||||
subject do
|
||||
@generator.sort_tags_by_date tags
|
||||
end
|
||||
it { is_expected.to be_a_kind_of(Array) }
|
||||
it { is_expected.to match_array(tags.reverse!) }
|
||||
end
|
||||
context "sort sorted tags" do
|
||||
tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
|
||||
before do
|
||||
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
||||
end
|
||||
subject do
|
||||
@generator.sort_tags_by_date tags
|
||||
end
|
||||
it { is_expected.to be_a_kind_of(Array) }
|
||||
it { is_expected.to match_array(tags) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,21 +1,21 @@
|
||||
describe GitHubChangelogGenerator::Parser do
|
||||
describe ".user_project_from_remote" do
|
||||
context "when remote is 1" do
|
||||
context "when remote is type 1" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||
end
|
||||
context "when remote is 2" do
|
||||
context "when remote is type 2" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||
end
|
||||
context "when remote is 3" do
|
||||
context "when remote is type 3" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||
end
|
||||
context "when remote is 4" do
|
||||
context "when remote is type 4" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||
@@ -27,9 +27,9 @@ describe GitHubChangelogGenerator::Parser do
|
||||
end
|
||||
end
|
||||
describe ".user_project_from_option" do
|
||||
# context "when option is invalid" do
|
||||
# it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
|
||||
# end
|
||||
context "when option is invalid" do
|
||||
it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
|
||||
end
|
||||
|
||||
context "when option is valid" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
|
||||
|
||||
Reference in New Issue
Block a user