github_changelog_entry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: baa32aa33e7e1860ea19a7c6bf7108e257a6d97d465e31c6fb907cff90e6e805
+  data.tar.gz: 16483518f5e399c26cd75c557df15f505988f02d530f1bb2bd8da2226ab11187
+SHA512:
+  metadata.gz: 27116d5e083f671840887579a6cbce97be0a4ecaca5dec3243387c4e8299f24acdc378aa925acefd63dc63fb7c601559ee99fe48067023665d187f0b6792b8a0
+  data.tar.gz: f9900ce2ca8978d145d438f548efbad89a2881c6f6cd43bc23bcc2fdcee36b7d4eae5476e12a76843159bd739e7780afae6af5b7cad74f8f7cbaa593355b648b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.6
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in github_changelog_entry.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    github_changelog_entry (0.1.0)
+      octokit (~> 4.0)
+      paint
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (11.0.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    octokit (4.13.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    paint (2.1.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  github_changelog_entry!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,52 @@
+# Github Changelog Entry
+
+Simple changelog assistant for a team working with github. Fetches issues from github and outputs them in a format that can be copy pasted into your changelog and edited to fit your needs.
+
+The idea here is NOT to have a fully automatic changelog.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "github_changelog_entry"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_changelog_entry
+
+## Usage
+
+### Generating a new changelog entry
+
+`gce generate -t <github_token> -r <repo_name>`
+
+This will use all of the issues created since the last release.
+
+### List of options
+
+```
+  -l, [--default-to-latest-tag], [--no-default-to-latest-tag]  # If false, will not try to limit the query to the issues created after a given tag
+                                                               # Default: true
+  -o, [--origin-tag=ORIGIN_TAG]                                # Choose a given tag as an origin
+  -m, [--milestone-number=MILESTONE_NUMBER]                    # Select issues linked to this milestone (the number needs to be in the milestone title separated by spaces)
+  -s, [--issue-state=ISSUE_STATE]                              # Override the state parameter
+                                                               # Default: closed
+                                                               # Possible values: open, closed, all
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alxckn/github_changelog_entry.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github_changelog_entry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gce

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'github_changelog_entry/cli'
+GithubChangelogEntry::CLI.start

data/github_changelog_entry.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github_changelog_entry/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_changelog_entry"
+  spec.version       = GithubChangelogEntry::VERSION
+  spec.authors       = ["Alexandre Chakroun"]
+  spec.email         = ["alexandre.chakroun@gmail.com"]
+
+  spec.summary       = %q{Create a new changelog entry using github API}
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "byebug"
+  spec.add_dependency "octokit", "~> 4.0"
+  spec.add_dependency "thor"
+  spec.add_dependency "paint"
+end

data/lib/github_changelog_entry.rb

@@ -0,0 +1,5 @@
+require "github_changelog_entry/version"
+
+module GithubChangelogEntry
+  class Error < StandardError; end
+end

data/lib/github_changelog_entry/cli.rb

@@ -0,0 +1,40 @@
+require "thor"
+require "paint"
+require "github_changelog_entry/github"
+require "github_changelog_entry/generator"
+require "byebug"
+
+module GithubChangelogEntry
+  class CLI < Thor
+    class_option :repo,  desc: "Repository",   aliases: "-r", required: true
+    class_option :token, desc: "Github token", aliases: "-t", required: true
+
+    desc "generate", "Generates a new changelog raw entry"
+    option :default_to_latest_tag,
+           aliases: "-l",
+           required: false,
+           default: true,
+           type: :boolean,
+           desc: %q{If false, will not try to limit the query to the issues created after a given tag}
+    option :origin_tag, aliases: "-o", required: false, desc: %q{Choose a given tag as an origin}
+    option :milestone_number, aliases: "-m", required: false, desc: %q{Select issues linked to this milestone (the number needs to be in the milestone title separated by spaces)}
+    option :issue_state, aliases: "-s", required: false, default: "closed", enum: ["open", "closed", "all"], desc: %q{Override the state parameter}
+    def generate
+      puts Paint["Generating a new changelog entry", :blue, :bold]
+
+      github_handler = GithubChangelogEntry::Github.new(options[:token], options[:repo])
+
+      issues_options = options.select do |key, value|
+        [
+          "origin_tag",
+          "milestone_number",
+          "default_to_latest_tag",
+          "issue_state"
+        ].include?(key)
+      end
+      GithubChangelogEntry::Generator.new.generate(
+        github_handler.closed_issues(issues_options)
+      )
+    end
+  end
+end

data/lib/github_changelog_entry/generator.rb

@@ -0,0 +1,40 @@
+require "github_changelog_entry/github"
+
+module GithubChangelogEntry
+  class Generator
+    def generate(issues)
+      print_version
+
+      print_section("Enhancements")
+      print_section("Bugs")
+      print_section("Chores")
+      print_section("Hotfix")
+
+      issues.each do |issue|
+        puts "  - [\\##{issue[:number]}](#{issue[:html_url]}): #{issue[:title]}"
+      end
+    end
+
+    private
+
+    def print_version
+      sep
+      new_line
+      puts "## <version_number>"
+      new_line
+    end
+
+    def print_section(section_name)
+      puts "### #{section_name}"
+      new_line
+    end
+
+    def new_line
+      puts ""
+    end
+
+    def sep
+      puts "--"
+    end
+  end
+end

data/lib/github_changelog_entry/github.rb

@@ -0,0 +1,71 @@
+require "octokit"
+require "paint"
+
+module GithubChangelogEntry
+  class Github
+    def initialize(github_token, repo)
+      @github_token = github_token
+      @repo = repo
+    end
+
+    def closed_issues(options = {})
+      filters = { state: "closed" }
+
+      tag_commit = if options["origin_tag"]
+        commit(options["origin_tag"])
+      elsif options["default_to_latest_tag"]
+        commit(nil)
+      end
+      filters = filters.merge(since: tag_commit[:commit][:committer][:date]) if tag_commit
+
+      if options["milestone_number"]
+        m = milestone(options["milestone_number"])
+        unless m.nil?
+          filters.merge!(milestone: m[:number])
+          puts Paint["Using milestone #{m[:title]}", :blue]
+        end
+      end
+
+      if options["issue_state"]
+        filters.merge!(state: options["issue_state"])
+      end
+
+      client.list_issues(@repo, filters).reject { |issue| issue.key?(:pull_request) }
+    end
+
+    private
+
+    def milestone(number)
+      client.list_milestones(@repo).find { |m| m[:title].include?(" #{number} ") }
+    end
+
+    def commit(tag_name)
+      tag = tag_name ? tags[clean_tag_name(tag_name)] : tags[tags.keys.sort.last]
+
+      puts Paint["Using tag version #{clean_tag_ref(tag[:ref])}", :blue]
+
+      client.commit(@repo, tag[:object][:sha])
+    end
+
+    def tags
+      @tags ||= Hash[
+        client.refs(@repo, :tag)
+        .map { |ref| [clean_tag_ref(ref[:ref]), ref] }
+        .reject { |ref| ref[0].nil? }
+      ]
+    end
+
+    def clean_tag_ref(ref)
+      tag = ref.match(/(\d+\.)?(\d+\.)?(\*|\d+)$/)
+      tag[0] if tag
+    end
+
+    def clean_tag_name(tag_name)
+      tag_name.gsub("v", "")
+    end
+
+    def client
+      @client ||= Octokit::Client.new(access_token: @github_token)
+    end
+  end
+end

data/lib/github_changelog_entry/version.rb

@@ -0,0 +1,3 @@
+module GithubChangelogEntry
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: github_changelog_entry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandre Chakroun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alexandre.chakroun@gmail.com
+executables:
+- gce
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gce
+- github_changelog_entry.gemspec
+- lib/github_changelog_entry.rb
+- lib/github_changelog_entry/cli.rb
+- lib/github_changelog_entry/generator.rb
+- lib/github_changelog_entry/github.rb
+- lib/github_changelog_entry/version.rb
+homepage: 
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Create a new changelog entry using github API
+test_files: []