github_changelog_generator 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a85fd9e4df53ccc764ea93c75383999a6a6731b4
-  data.tar.gz: 6d2713c79a1fccc559c660c92706a8c8dfc84d3a
+  metadata.gz: dc28a7bacd92b9bd2e5abdef760d348fc711540c
+  data.tar.gz: fb8856f86cd8e9988481f407b667f22209307563
 SHA512:
-  metadata.gz: 1bef64c1b569079d0954b1d311b6148211e15b6351c67bd8ec4446961fe3daa159a544a6d6b1ff6449492b1ac9943c20c1706f04bfbee41c0e064c80af50fa19
-  data.tar.gz: d99a95dae2167ab00aaa75217d0d682fd0be5a314fd4b43794113e60cf7b8f27da8c1abb81111b0d7844dcfcd4026c51297b7d5ffc9d324982fcf92623ac884a
+  metadata.gz: 0e0d0694c082fc9f51f47f30baa3d1f1572ecbf20d773564c1e8fd22fb9f31f421fd60c76f695502082c258193716689e904cc762cb5f1eefea214a62233073e
+  data.tar.gz: d1a2a0aef52861f68563d3fec4fca64e46b5f794a09669cfdc49fbfc0336f763e61ad1d0676291a9f218834bf4bbcf27e237902129adb2947c209447743a1606

data/.gitignore

@@ -0,0 +1 @@
+/lib/CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+## [1.1.3] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.3)
+#### 18/11/14
+- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23)
+
+- *Implemented enhancement:* Implement ability to retrieve GitHub token from some shell variable (to not put it to script directly) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
+
+- *Fixed bug:* Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
+
+## [1.1.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2)
+#### 12/11/14
+- *Merged pull-request:* Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18)
+
+- *Merged pull-request:* Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17)
+
+## [1.1.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
+#### 10/11/14
+- *Merged pull-request:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15)
+
+- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14)
+
+- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13)
+
+## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
+#### 10/11/14
+- *Implemented enhancement:* Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
+
+- *Fixed bug:* Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
+
+- *Fixed bug:* Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
+
+## [1.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1)
+#### 10/11/14
+- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8)
+
+## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
+#### 07/11/14
+- *Merged pull-request:* Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7)
+
+- *Merged pull-request:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3)
+
+- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
+
+- *Implemented enhancement:* Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
+
+- *Fixed bug:* Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
+
+## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
+#### 07/11/14
+- *Merged pull-request:* Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2)
+
+- *Merged pull-request:* Add option (-o --output) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1)
+
+## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
+#### 06/11/14
+## [0.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
+#### 06/11/14
+
+
+\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'github_api'
+gem 'colorize'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    colorize (0.7.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    github_api (0.12.2)
+      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.3.1)
+    jwt (1.0.0)
+    mini_portile (0.6.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.4)
+      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)
+    rack (1.5.2)
+    thread_safe (0.3.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  colorize
+  github_api

data/README.md

@@ -0,0 +1,85 @@
+GitHub Changelog Generator
+==================
+
+[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+
+Changelog generation has never been so easy.
+
+This script automatically generate change-log from your tags and merged pull-requests.
+
+## Installation:
+	[sudo] gem install github_changelog_generator
+
+## Usage
+**It's really simple**: 
+
+- `cd` to your Project folder with configured git and just type:
+
+		github_changelog_generator
+
+- from anywhere:
+
+		github_changelog_generator -u github-username -p github-project
+     
+As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
+
+## Params:
+Type `github_changelog_generator --help` for detailed usage.
+
+    Usage: 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 this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
+    -h, --help                       Displays Help
+    -v, --[no-]verbose               Run verbosely. Default is true
+        --[no-]issues                Include closed issues to changelog. Default is true
+        --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
+        --[no-]pull-requests         Include pull-requests to changelog. Default is true
+    -l, --last-changes               Generate log between last 2 tags only
+    -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
+    -o, --output [NAME]              Output file. Default is CHANGELOG.md
+        --labels  x,y,z              List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
+
+## Examples:
+
+- Look at changelog for **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+- This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
+
+		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+
+
+## FAQ:
+Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
+
+**You can easily [generate it here](https://github.com/settings/applications)**.
+
+And:
+
+- Run with key `-t [your-16-digit-token]` that 
+- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
+ 		
+	i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string `export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'`
+
+So, if you got error like this:
+>! /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.
+
+## Am I missed some essential feature?
+
+**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
+
+*Bug reports, feature requests, patches, well-wishes are always welcome!*
+
+## Contributing
+
+1. Create an issue to discuss about 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. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## License
+
+Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/bin/github_changelog_generator

@@ -1,5 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 require 'github_changelog_generator'
-
-ChangelogGenerator.new.compund_changelog
+GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog

data/bump_gemfile.rb

@@ -0,0 +1,227 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+SPEC_TYPE = 'gemspec'
+
+:major
+:minor
+:patch
+
+@options = {:dry_run => false, :bump_number => :patch}
+
+OptionParser.new { |opts|
+  opts.banner = 'Usage: bump.rb [options]'
+
+  opts.on('-d', '--dry-run', 'Dry run') do |v|
+    @options[:dry_run] = v
+  end
+  opts.on('-a', '--major', 'Bump major version') do |v|
+    @options[:bump_number] = :major
+  end
+  opts.on('-m', '--minor', 'Bump minor version') do |v|
+    @options[:bump_number] = :minor
+  end
+  opts.on('-p', '--patch', 'Bump patch version') do |v|
+    @options[:bump_number] = :patch
+  end
+  opts.on('-r', '--revert', 'Revert last bump') do |v|
+    @options[:revert] = v
+  end
+}.parse!
+
+p @options
+
+def check_repo_is_clean_or_dry_run
+  value =%x[#{'git status --porcelain'}]
+
+  if value.empty?
+    puts 'Repo is clean -> continue'
+  else
+    if @options[:dry_run]
+      puts 'Repo not clean, "Dry run" enabled -> continue'
+    else
+      puts 'Repository not clean -> exit'
+      exit
+    end
+  end
+end
+
+
+def find_spec_file
+  list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
+  arr = list_of_specs.split("\n")
+
+  spec_file = ''
+
+  case arr.count
+    when 0
+      puts "No #{SPEC_TYPE} files found. -> Exit."
+      exit
+    when 1
+      spec_file = arr[0]
+    else
+      puts 'Which spec should be used?'
+      arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
+      input_index = Integer(gets.chomp)
+      spec_file = arr[input_index-1]
+  end
+
+  if spec_file == nil
+    puts "Can't find specified spec file -> exit"
+    exit
+  end
+
+  spec_file.sub('./', '')
+
+end
+
+def find_current_gem_file
+  list_of_specs = execute_line("find . -name '*.gem'")
+  arr = list_of_specs.split("\n")
+
+  spec_file = ''
+
+  case arr.count
+    when 0
+      puts "No #{SPEC_TYPE} files found. -> Exit."
+      exit
+    when 1
+      spec_file = arr[0]
+    else
+      puts 'Which spec should be used?'
+      arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
+      input_index = Integer(gets.chomp)
+      spec_file = arr[input_index-1]
+  end
+
+  if spec_file == nil
+    puts "Can't find specified spec file -> exit"
+    exit
+  end
+
+  spec_file.sub('./', '')
+
+end
+
+def find_version_in_podspec(podspec)
+  readme = File.read(podspec)
+
+  #try to find version in format 1.22.333
+  re = /(\d+)\.(\d+)\.(\d+)/m
+
+  match_result = re.match(readme)
+
+  unless match_result
+    puts 'Not found any versions'
+    exit
+  end
+
+  puts "Found version #{match_result[0]}"
+  return match_result[0], match_result.captures
+end
+
+def bump_version(versions_array)
+  bumped_result = versions_array.dup
+  bumped_result.map! { |x| x.to_i }
+
+  case @options[:bump_number]
+    when :major
+      bumped_result[0] += 1
+      bumped_result[1] = 0
+      bumped_result[2] = 0
+    when :minor
+      bumped_result[1] += 1
+      bumped_result[2] = 0
+    when :patch
+      bumped_result[2] += 1
+    else
+      raise('unknown bump_number')
+  end
+
+
+  bumped_version = bumped_result.join('.')
+  puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
+  bumped_version
+end
+
+def execute_line(line)
+  output = `#{line}`
+  check_exit_status(output)
+
+  output
+end
+
+def execute_line_if_not_dry_run(line)
+  if @options[:dry_run]
+    puts "Dry run: #{line}"
+    nil
+  else
+    puts line
+    value = %x[#{line}]
+    puts value
+    check_exit_status(value)
+    value
+  end
+end
+
+def check_exit_status(output)
+  if $?.exitstatus != 0
+    puts "Output:\n#{output}\nExit status = #{$?.exitstatus} ->Terminate script."
+    exit
+  end
+end
+
+def run_bumping_script
+
+  check_repo_is_clean_or_dry_run
+  spec_file = find_spec_file
+  result, versions_array = find_version_in_podspec(spec_file)
+  bumped_version = bump_version(versions_array)
+
+  unless @options[:dry_run]
+    puts 'Are you sure? Press Y to continue:'
+    str = gets.chomp
+    if str != 'Y'
+      puts '-> exit'
+      exit
+    end
+  end
+
+  execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" README.md")
+  execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
+  execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
+  execute_line_if_not_dry_run("git tag #{bumped_version}")
+  execute_line_if_not_dry_run('git push')
+  execute_line_if_not_dry_run('git push --tags')
+  execute_line_if_not_dry_run("gem build #{spec_file}")
+
+  gem = find_current_gem_file
+  execute_line_if_not_dry_run("gem push #{gem}")
+  # execute_line_if_not_dry_run("pod trunk push #{spec_file}")
+
+end
+
+def revert_last_bump
+  spec_file = find_spec_file
+  result, _ = find_version_in_podspec(spec_file)
+
+  puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
+  str = gets.chomp
+  if str != 'Y'
+    puts '-> exit'
+    exit
+  end
+  execute_line_if_not_dry_run("git tag -d #{result}")
+  execute_line_if_not_dry_run('git reset --hard HEAD~1')
+  execute_line_if_not_dry_run("git push --delete origin #{result}")
+end
+
+if __FILE__ == $0
+
+  if @options[:revert]
+    revert_last_bump
+  else
+    run_bumping_script
+  end
+
+end