github_changelog_generator 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5baba2054c1d760b300ab11776f9d18e91500a0
-  data.tar.gz: 4083db4ad487e4809cc3aadc9b071daaa5aed822
+  metadata.gz: 202f122f1d16c0c0ffb31c835611647ea0090a66
+  data.tar.gz: eff1192c30c02b2b72bc2f22449510ed2c6c0bf2
 SHA512:
-  metadata.gz: 2581324624bdb0a1311ccd6f71f0580445cde465777044180f901279591c4f25031a94d982891a185b7adcf5e7a0d00b90d299476f754e3ac302475369875388
-  data.tar.gz: cdbad548c27826c616d8186d9c9c4aeae017d009ff504c911e0a5447917a8aa46100847843450a280342790c468088ff5b406df4a91b1f35158caa688701a4c7
+  metadata.gz: eb81c3164e100a0cf9c073c08ceb14d1b8e33d27b4ece4e693f8d7b60681c3b78c561d91b37c35c8003711a2d76cf200e28dd6ad9f7444eed00ab4221614a869
+  data.tar.gz: 6e153f5835447b3fd689ac157789bef00b2e2686b4cc8b320709da71c1fac7b68522b65cb010e91fbd0cdc88186289f2fa0646af27cfefa5aaf2fc585f25bce9

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.2.4] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4)
+#### 16/12/14
+- *Merged pull-request:* Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
+
+- *Implemented enhancement:* Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
+
+- *Implemented enhancement:* Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
+
+- *Fixed bug:* Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
+
+## [1.2.3] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3)
+#### 16/12/14
+- *Fixed bug:* Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
+
 ## [1.2.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2)
 #### 10/12/14
 - *Merged pull-request:* Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))

data/lib/github_changelog_generator.rb

@@ -28,12 +28,12 @@ module GitHubChangelogGenerator
 
       github_token
 
-      if @github_token.nil?
-        @github = Github.new per_page: PER_PAGE_NUMBER
-      else
-        @github = Github.new oauth_token: @github_token,
-                             per_page: PER_PAGE_NUMBER
-      end
+      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 = Github.new github_options
 
       @generator = Generator.new(@options)
 
@@ -231,6 +231,11 @@ module GitHubChangelogGenerator
 
     def generate_log_between_tags(older_tag, newer_tag)
 
+      if newer_tag.nil?
+        puts "Can't find tag -> terminate"
+        exit 1
+      end
+
       newer_tag_time = self.get_time_of_tag(newer_tag)
       newer_tag_name = newer_tag['name']
 
@@ -243,6 +248,43 @@ module GitHubChangelogGenerator
         filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
       end
 
+
+      if @options[:filter_issues_by_milestone]
+        #delete excess irrelevant issues (according milestones)
+        filtered_issues.select! { |issue|
+          if issue.milestone.nil?
+            true
+          else
+            #check, that this milestone in tag list:
+            milestone_is_tag = @all_tags.find { |tag|
+              tag.name == issue.milestone.title
+            }
+            milestone_is_tag.nil?
+          end
+
+        }
+
+        #add missed issues (according milestones)
+        issues_to_add = @issues.select { |issue|
+          if issue.milestone.nil?
+            false
+          else
+            #check, that this milestone in tag list:
+            milestone_is_tag = @all_tags.find { |tag|
+              tag.name == issue.milestone.title
+            }
+
+            if milestone_is_tag.nil?
+              false
+            else
+              issue.milestone.title == newer_tag_name
+            end
+          end
+        }
+
+        filtered_issues |= issues_to_add
+      end
+
       self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time)
 
     end
@@ -276,8 +318,10 @@ module GitHubChangelogGenerator
 # @return [String]
     def create_log(pull_requests, issues, tag_name, tag_time)
 
+      github_site = options[:github_site] || 'https://github.com'
+
       # Generate tag name and link
-      log = "## [#{tag_name}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
+      log = "## [#{tag_name}] (#{github_site}/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
 
       #Generate date string:
       time_string = tag_time.strftime @options[:format]

data/lib/github_changelog_generator/generator.rb

@@ -10,10 +10,10 @@ module GitHubChangelogGenerator
 
       merge = "#{@options[:merge_prefix]}#{encapsulated_title} [\\##{pull_request[:number]}](#{pull_request.html_url})"
       if @options[:author]
-        if !pull_request.user.nil?
-          merge += " ([#{pull_request.user.login}](#{pull_request.user.html_url}))\n\n"
-        else
+        if pull_request.user.nil?
           merge += " ({Null user})\n\n"
+        else
+          merge += " ([#{pull_request.user.login}](#{pull_request.user.html_url}))\n\n"
         end
       else
         merge += "\n\n"

data/lib/github_changelog_generator/parser.rb

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 require 'optparse'
-require 'PP'
+require 'pp'
 require_relative 'version'
 
 module GitHubChangelogGenerator
   class Parser
     def self.parse_options
-      options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ', :author => true, :pull_request_labels => nil}
+      options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ', :author => true, :pull_request_labels => nil, :filter_issues_by_milestone => true}
 
       parser = OptionParser.new { |opts|
         opts.banner = 'Usage: changelog_generator [options]'
@@ -37,6 +37,9 @@ module GitHubChangelogGenerator
         opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
           options[:pulls] = v
         end
+        opts.on('--[no-]filter-issues-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
+          options[:filter_issues_by_milestone] = last
+        end
         opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
           options[:last] = author
         end
@@ -46,6 +49,12 @@ module GitHubChangelogGenerator
         opts.on('--labels-pr x,y,z', Array, 'Only pull requests with specified labels will be included to changelog. Default is nil') do |list|
           options[:pull_request_labels] = list
         end
+        opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
+          options[:github_site] = last
+        end
+        opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
+          options[:github_endpoint] = last
+        end
         opts.on('-v', '--version', 'Print version number') do |v|
           puts "Version: #{GitHubChangelogGenerator::VERSION}"
           exit
@@ -59,8 +68,9 @@ module GitHubChangelogGenerator
       parser.parse!
 
       if ARGV[0] && !ARGV[1]
+        github_site = options[:github_site] ? options[:github_site] : 'github.com'
         # this match should parse https://github.com/skywinder/Github-Changelog-Generator and skywinder/Github-Changelog-Generator to user and name
-        match = /(?:.+github\.com\/)?(.+)\/(.+)/.match(ARGV[0])
+        match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
 
         if match[2].nil?
           exit
@@ -94,4 +104,4 @@ module GitHubChangelogGenerator
       options
     end
   end
-end
+end

data/lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = '1.2.4'
+  VERSION = '1.2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Petr Korolev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Script, that automatically generate change-log from your tags and pull-requests.