Merge branch 'release/1.6.1'

This commit is contained in:
Petr Korolev 2015-06-12 11:42:04 +03:00
commit 243f0cf292
6 changed files with 36 additions and 35 deletions

View File

@ -1,5 +1,5 @@
# This configuration was generated by `rubocop --auto-gen-config` # This configuration was generated by `rubocop --auto-gen-config`
# on 2015-06-11 16:35:14 +0300 using RuboCop version 0.31.0. # on 2015-06-12 11:23:12 +0300 using RuboCop version 0.31.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
@ -7,7 +7,7 @@
# Offense count: 13 # Offense count: 13
Metrics/AbcSize: Metrics/AbcSize:
Max: 63 Max: 71
# Offense count: 1 # Offense count: 1
Metrics/CyclomaticComplexity: Metrics/CyclomaticComplexity:

View File

@ -80,38 +80,9 @@ Because software tools are for people. If you dont care, why are you contribu
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog. As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
### Params ### Params
Type `github_changelog_generator --help` for detailed usage. Type `github_changelog_generator --help` for details.
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
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 ### GitHub token

View File

@ -1,5 +1,23 @@
# Change Log # 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 [\#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)
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22) ## [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) [Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)

View File

@ -166,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], obj = @github.issues.events.list user: @options[:user],
repo: @options[:project], repo: @options[:project],
issue_number: issue["number"] issue_number: issue["number"]
issue[:events] = obj.body
rescue rescue
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end end
issue[:events] = obj.body
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}") print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
i += 1 i += 1
end end

View File

@ -50,6 +50,18 @@ 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("--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("--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| opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
options[:issues] = v options[:issues] = v
end end

View File

@ -1,3 +1,3 @@
module GitHubChangelogGenerator module GitHubChangelogGenerator
VERSION = "1.6.0" VERSION = "1.6.1"
end end