changelog-madness 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 499823ae899128b36e1aa820e3a3e7a0bc4598df748bc6901e589ecd47de977e
+  data.tar.gz: d048453e0b4b0509567aa9b81f2c00150b86094390e832b775c399bd9b13203f
+SHA512:
+  metadata.gz: 59c981d0070aaf230511d23426becd73fc13b9dbd350c2c7cc0ce1c40a75a648eaa978b4c35737b023fd4b7e79d75cf6b2e8c7fb104ea1026a6c6870791a7f5e
+  data.tar.gz: 36cc28b38c16b2aa7cf625d631524b274f83651c3dbbd64baf05c38b27234dc4e09a0088bd08d988f86c309dcde88061df3ce16aab0ba8f7db831e8aa34173be

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "ruby.codeCompletion": "rcodetools",
+    "ruby.format": "rubocop",
+    "ruby.intellisense": "rubyLocate"
+}

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+**Note:** This file is automatically generated.
+
+# Changelog
+
+## 1.0.0
+
+### Other (1 change)
+
+-  Update the readme (ajoly)
+
+
+## 0.0.1
+
+- No changes.
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexandre.joly@kilokilo.ch. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in changelog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alexandre Joly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# Changelog
+
+_Stop the changelog merge conflict madness!_
+
+This tool helps you maintaining a CHANGELOG by creating one file per entry and
+bundling them together before you release a new version of your application.
+
+This tool was inspired by the article '[How we solved GitLab's CHANGELOG conflict crisis](https://about.gitlab.com/2018/07/03/solving-gitlabs-changelog-conflict-crisis/)' from Gitlab. And yeah well I used some of their code too... At this point, I want to say thank you to the Gitlab team for the great work you guys are doing. 👏👏👏
+
+## Installation
+
+Install _changelog_ using
+
+```shell
+gem install changelog-madness
+```
+
+## Usage
+
+### New Entry
+
+Create a new entry by running
+
+```shell
+changelog 
+
+#this is an alias for `changelog gen`
+```
+
+this will create a new file in the `changelogs/unreleased/` folder.
+
+Run `changelog help gen` to see all available options
+
+### Bundling
+
+Bundle all the unreleased entries by running
+
+```shell
+# changelog bundle <VERSION>
+changelog bundle 2.3.1
+```
+
+this will create or update the `CHANGELOG.md`
+
+Run `changelog help bundle` to see all available options
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/KiloKilo/changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Changelog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/KiloKilo/changelog/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "changelog"
+
+# 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/changelog-madness.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "changelog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "changelog-madness"
+  spec.version       = Changelog::VERSION
+  spec.authors       = ["Alexandre Joly"]
+  spec.email         = ["alexandre.joly@kilokilo.ch"]
+
+  spec.summary       = %q{Stop the changelog merge conflict madness}
+  spec.description   = %q{A tool to create changelog entries and bind them together}
+  spec.homepage      = "https://github.com/KiloKilo/changelog"
+  spec.license       = "MIT"
+
+  
+  # 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"]
+
+
+  # add dependencies
+  spec.add_dependency 'thor', '~> 0'
+  spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'activesupport', '~> 4.2'
+
+  # add dependencies specially for development needs
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "irb", "~> 1.0.0"
+
+end

data/exe/changelog

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'changelog/cli'
+require 'changelog/helper'
+require 'colorize'
+
+begin
+    Changelog::CLI.start
+rescue Changelog::Helper::Abort => ex
+    $stderr.puts ex.message
+    exit 1
+rescue Changelog::Helper::Done
+    exit
+rescue Interrupt
+    $stderr.puts "\nAbort mission! I repeat! Abort mission!".red
+    exit 1
+end
+
+

data/lib/changelog/bundler.rb

@@ -0,0 +1,91 @@
+require 'yaml'
+require 'changelog/markdown_generator'
+require 'changelog/updater'
+require 'colorize'
+
+module Changelog
+
+	class Bundler
+		include Changelog::Helper
+		
+		def initialize(version, changelog_file, include_date = false, no_commit = false, dry_run = false, force = false)
+			@version = version
+			@changelog_file = changelog_file || 'CHANGELOG.md'
+			@include_date = include_date
+			@unreleased_entries = nil
+			@no_commit = no_commit
+			@dry_run = dry_run
+			@force = force
+		end
+
+		def execute
+			assert_entries!
+
+			update_changelog
+
+			delete_file_entries
+
+			commit_changes unless @no_commit || @dry_run
+		end
+
+		private
+
+		def update_changelog
+			markdown = Changelog::MarkdownGenerator.new(@version, unreleased_entries, include_date: @include_date).to_s
+
+			updater = Updater.new(@changelog_file, @dry_run)
+			updater.insert(@version, markdown)
+
+		end
+
+		def commit_changes
+			success = Kernel.system("git add #{@changelog_file} #{unreleased_path}")
+			success &&= Kernel.system("git commit -m \"🧾 Update #{@changelog_file} for v#{@version.to_patch}\n\n[ci skip]\"")
+
+			fail_with "Files could not be commited" unless success
+		end
+
+		def unreleased_entries
+			return @unreleased_entries if @unreleased_entries
+
+			@unreleased_entries = []
+
+			unreleased_paths.each do |fname|		
+				@unreleased_entries << Entry.from_yml(fname)
+			end
+
+			@unreleased_entries
+		end
+
+		def unreleased_path
+			File.join('changelogs', 'unreleased')
+		end
+
+		def unreleased_paths
+			Dir.glob(File.join(unreleased_path, '*.yml'))
+		end
+
+		def delete_file_entries
+			unreleased_paths.each do |path|
+				if @dry_run
+					$stdout.puts "#{'delete'.red} #{path}"
+					next
+				end
+
+				File.delete(path) if File.exist?(path)
+
+			end
+		end
+
+		def assert_entries!
+			return if unreleased_entries.length > 0
+			return if @force
+
+			fail_with "No entries in '#{unreleased_path}' available! Use `--force` to write an empty version."
+		end
+		
+	end
+end
+
+
+# vim: ft=ruby

data/lib/changelog/cli.rb

@@ -0,0 +1,66 @@
+require 'thor'
+require 'changelog'
+require 'changelog/entry'
+require 'changelog/generator'
+require 'changelog/bundler'
+require 'colorize'
+
+module Changelog
+    class CLI < Thor
+        default_task :gen_entry
+
+        method_option :ammend, :type => :boolean, :default => false, :desc => 'Amend the previous commit'
+        method_option :force, :type => :string, :aliases => "-f", :desc => 'Overwrite an existing entry'
+        method_option "merge-request", :type => :numeric, :aliases => "-m", :desc => 'Merge Request ID'
+        method_option "issue", :type => :numeric, :aliases => "-i", :desc => 'Issue ID'
+        method_option "dry-run", :type => :boolean, :aliases => "-n", :desc => "Don't actually write anything, just print"
+        method_option :author, :type => :string, :aliases => "-u", :desc => 'Overwrite the author of the change'
+        method_option :type, :type => :string, :aliases => "-t", :desc => "The category of the change", :enum => Changelog::Entry::TYPES.map(&:name)
+        desc 'gen [TITLE]', 'Generate a new changelog entry'
+        def gen_entry(title="") 
+            type = options.type || read_type
+            
+            generator = Changelog::Generator.new(title, type, options.author, options.issue, options["merge-request"], options.amend, options.force)
+            generator.execute(options["dry-run"])
+        end
+        
+        
+        method_option "changelog-file", :type => :string, :aliases => "-c", :desc => 'The name of the changelog file'
+        method_option "include-date", :type => :boolean, :aliases => "-d", :desc => 'Include the date in the release'
+        method_option "dry-run", :type => :boolean, :aliases => "-n", :desc => "Don't actually write anything, just print"
+        method_option "no-commit", :type => :boolean, :default => false, :desc => 'Do not commit the changelog'
+        method_option :force, :type => :string, :aliases => "-f", :desc => 'Write an empty version if there is no entries'
+        desc 'bundle VERSION', 'Bundle the changelogs entry to a new version'
+        def bundle_entries(version) 
+            semver = Changelog::SemanticVersion::new(version)
+
+            bundler = Changelog::Bundler.new(semver, options['changelog-file'], options['include-date'], options['no-commit'], options["dry-run"],  options["force"])
+            bundler.execute
+        end
+
+        private
+
+        def read_type
+            read_type_message
+
+            type = Changelog::Entry::TYPES[$stdin.getc.to_i - 1]
+            assert_valid_type!(type)
+
+            type.name
+        end
+
+        def read_type_message
+            $stdout.puts "\n>> Please specify the index for the category of your change:"
+            Changelog::Entry::TYPES.each_with_index do |type, index|
+                $stdout.puts "#{index + 1}. #{type.description}"
+            end
+            $stdout.print "\n?> "
+        end
+
+        def assert_valid_type!(type)
+            unless type
+                raise Abort, "Invalid category index, please select an index between 1 and #{Changelog::Entry::TYPES.length}"
+            end
+        end
+   end 
+end

data/lib/changelog/entry.rb

@@ -0,0 +1,80 @@
+require 'yaml'
+require 'changelog'
+
+module Changelog
+	class Entry
+		attr_reader :title, :type, :issue, :merge_request, :author
+
+		Type = Struct.new(:name, :description)
+		TYPES = [
+			Type.new('added', 'New feature'),
+			Type.new('fixed', 'Bug fix'),
+			Type.new('changed', 'Feature change'),
+			Type.new('deprecated', 'New deprecation'),
+			Type.new('removed', 'Feature removal'),
+			Type.new('security', 'Security fix'),
+			Type.new('performance', 'Performance improvement'),
+			Type.new('other', 'Other')
+		].freeze
+
+		class << self
+
+			def from_yml(path)
+				parse_blob(File.read(path))
+			end
+				
+			private
+		
+			def parse_blob(content) 
+				yaml = YAML.safe_load(content)
+
+				Entry.new(yaml['title'], yaml['type'], yaml['author'], yaml['issue'], yaml['merge_request'])
+			end
+		end
+
+
+		def initialize(title, type, author, issue, merge_request)
+			@title = title
+			@type = parse_type(type) 
+			@author = author 
+			@issue = issue
+			@merge_request = merge_request
+		end
+
+		def to_s
+			str = +""
+			str << "#{title}".gsub(/\.{2,}$/, '.')
+			str << " ##{issue}" if !issue.nil?
+			str << " !#{merge_request}" if !merge_request.nil?
+			str << " (#{author})" if !author.nil?
+
+			str
+		end
+
+		def valid?
+			!@title.nil?
+		end
+
+		def to_yml
+			yaml_content = YAML.dump(
+				'title'         => @title,
+				'type'          => @type,
+				'issue'         => @issue,
+				'merge_request' => @merge_request,
+				'author'        => @author,
+			)
+			remove_trailing_whitespace(yaml_content)
+		end
+
+		private
+
+		def parse_type(type)
+			TYPES.map(&:name).include?(type) ? type : 'other'
+		end
+
+		def remove_trailing_whitespace(yaml_content)
+			yaml_content.gsub(/ +$/, '')
+		end
+
+	end
+end

data/lib/changelog/generator.rb

@@ -0,0 +1,148 @@
+require 'optparse'
+require 'yaml'
+require 'fileutils'
+require 'colorize'
+require 'changelog/helper'
+
+
+INVALID_TYPE = -1
+
+module Changelog
+
+  class Generator
+    include Changelog::Helper
+
+    def initialize(title, type, author, issue, merge_request, amend, force = false)
+      @entry = Changelog::Entry.new(
+        parse_title(title), 
+        type, 
+        parse_author(author), 
+        parse_issue(issue), 
+        merge_request
+      )
+
+      @amend = amend
+      @force = force
+    end
+
+    def execute(dry_run=false)
+      assert_feature_branch!
+      assert_title! unless editor
+      assert_new_file!
+
+      $stdout.puts "#{'create'.green} #{file_path}"
+      $stdout.puts contents
+
+      unless dry_run
+        write
+        amend_commit if @amend
+      end
+
+      if editor
+        system("#{editor} '#{file_path}'")
+      end
+    end
+
+    private
+
+    def contents
+      @entry.to_yml
+    end
+
+    def write
+      dirname = File.dirname(file_path)
+      unless File.directory?(dirname)
+        FileUtils.mkdir_p(dirname)
+      end
+
+      File.write(file_path, contents)
+    end
+
+    def editor
+      ENV['EDITOR']
+    end
+
+    def amend_commit
+      fail_with "git add failed" unless system(*%W[git add #{file_path}])
+
+      Kernel.exec(*%w[git commit --amend])
+    end
+
+    def assert_feature_branch!
+      return unless branch_name == 'master' and not @force
+
+      fail_with "Create a branch first!"
+    end
+
+    def assert_new_file!
+      return unless File.exist?(file_path)
+      return if @force
+
+      fail_with "#{file_path} already exists! Use `--force` to overwrite."
+    end
+
+    def assert_title!
+      return if @entry.title.length > 0 || @amend
+
+      fail_with "Provide a title for the changelog entry or use `--amend`" \
+        " to use the title from the previous commit."
+    end
+
+    def assert_valid_type!
+      return unless @entry.type && @entry.type == INVALID_TYPE
+
+      fail_with 'Invalid category given!'
+    end
+
+    def parse_title(title)
+      return title unless title.empty?
+      
+      last_commit_subject
+    end
+
+    def parse_author(author)
+      return author unless author.nil?
+
+      git_user_name
+    end
+
+    def parse_issue(issue)
+      return issue unless issue.nil?
+
+      issue_nr_from_branch
+    end
+
+    def git_user_name
+      capture_stdout(%w[git config user.name]).strip
+    end
+
+    def last_commit_subject
+      capture_stdout(%w[git log --format=%s -1]).strip
+    end
+
+    def issue_nr_from_branch
+      found = branch_name.scan(/\/?(\d+)-/).first
+      found.first unless found.nil?
+    end
+
+    def file_path
+      base_path = File.join(
+        unreleased_path,
+        branch_name.gsub(/[^\w-]/, '-'))
+
+      # Add padding for .yml extension
+      base_path[0..MAX_FILENAME_LENGTH - 5] + '.yml'
+    end
+
+    def unreleased_path
+      File.join('changelogs', 'unreleased')
+    end
+
+    def branch_name
+      @branch_name ||= capture_stdout(%w[git symbolic-ref --short HEAD]).strip
+    end
+
+  end
+end
+
+# vim: ft=ruby

data/lib/changelog/helper.rb

@@ -0,0 +1,21 @@
+require 'changelog'
+require 'colorize'
+
+module Changelog
+    module Helper
+        Abort = Class.new(StandardError)
+        Done = Class.new(StandardError)
+
+        MAX_FILENAME_LENGTH = 140 # ecryptfs has a limit of 140 characters
+
+        def capture_stdout(cmd)
+            output = IO.popen(cmd, &:read)
+            fail_with "command failed: #{cmd.join(' ')}" unless $?.success?
+            output
+        end
+
+        def fail_with(message)
+            raise Abort, "#{'error'.red} #{message}"
+        end
+    end
+end

data/lib/changelog/markdown_generator.rb

@@ -0,0 +1,79 @@
+require 'changelog/semantic_version'
+require 'active_support/core_ext/string'
+
+module Changelog
+
+    class MarkdownGenerator
+        attr_reader :version, :entries
+
+        def initialize(version, entries, include_date: false)
+            @version = version
+            @entries = entries.select(&:valid?)
+            @include_date = include_date
+        end
+
+        def to_s
+            markdown = StringIO.new
+            markdown.puts header
+            markdown.puts
+
+            if entries.empty?
+                markdown.puts "- No changes.\n\n"
+            else
+                markdown.puts formatted_entries
+            end
+
+            markdown.puts
+
+            markdown.string
+        end
+
+        private
+
+        def header
+            head = "## #{version.to_patch}"
+            head += " (#{date})" if @include_date
+            head
+        end
+
+        def date
+            Date.today.strftime("%Y-%m-%d")
+        end
+
+        def entries_grouped_by_type(type) 
+            entries.select { |entry| entry.type == type }
+        end
+
+        # Group entries by type found in the `Changelog::Entry::TYPES`.
+        # Output example:
+        #
+        # ### Fixed (52 changes)
+        # - Fix 404 errors in API caused when the branch name had a dot. #42 !14462 (ajoly)
+        def formatted_entries
+            result = +''
+
+            Changelog::Entry::TYPES.map(&:name).each do |type|
+                grouped_entries = entries_grouped_by_type(type)
+                changes_count = grouped_entries.size
+
+                # Do nothing if no changes are presented for the current type.
+                next unless changes_count.positive?
+
+                # Prepare the group header.
+                # Example:
+                # ### Added (54 changes)
+                changes = [changes_count, 'change'.pluralize(changes_count)].join("\s")
+
+                result << "### #{type.capitalize} (#{changes})\n\n"
+
+                # Add entries to the group.
+                grouped_entries.each { |entry| result << "-  #{entry}\n" }
+
+                result << "\n"
+            end
+            
+            result
+        end
+    end
+end
+

data/lib/changelog/semantic_version.rb

@@ -0,0 +1,77 @@
+module Changelog
+    class SemanticVersion < String
+    
+        VERSION_REGEX = %r{
+            \A(?<major>\d+)
+            \.(?<minor>\d+)
+            (\.(?<patch>\d+))?
+            \z
+            }x.freeze
+
+        def initialize(version_string)
+            super(version_string)
+
+            if valid? && extract_from_version(:patch, fallback: nil).nil?
+                super(to_patch)
+            end
+        end
+
+        def ==(other)
+            if other.respond_to?(:to_patch)
+                to_patch.eql?(other.to_patch)
+            else
+                super
+            end
+        end
+
+        def <=>(other)
+            return nil unless other.is_a?(SemanticVersion)
+            return 0 if self == other
+
+            if major > other.major ||
+                (major >= other.major && minor > other.minor) ||
+                (major >= other.major && minor >= other.minor && patch > other.patch)
+                1
+            else
+                -1
+            end
+        end
+
+        def major
+            @major ||= extract_from_version(:major).to_i
+        end
+
+        def minor
+            @minor ||= extract_from_version(:minor).to_i
+        end
+
+        def patch
+            @patch ||= extract_from_version(:patch).to_i
+        end
+
+        def to_minor
+            "#{major}.#{minor}"
+        end
+        
+        def to_patch
+            "#{major}.#{minor}.#{patch}"
+        end
+
+
+        def valid?
+            self.class::VERSION_REGEX.match?(self)
+        end
+
+        private 
+
+        def extract_from_version(part, fallback: 0)
+            match_data = self.class::VERSION_REGEX.match(self)
+            if match_data && match_data.names.include?(part.to_s) && match_data[part]
+                String.new(match_data[part])
+            else
+                fallback
+            end
+        end
+
+    end
+end

data/lib/changelog/updater.rb

@@ -0,0 +1,71 @@
+require 'changelog/semantic_version'
+
+module Changelog
+    class Updater 
+   
+        def initialize(path, dry_run = false)
+            @path = path
+            @dry_run = dry_run
+        end
+
+        def insert(version, markdown) 
+
+            create_file unless File.file?(@path)
+
+            versions_found = false
+
+            contents = File.read(@path).lines if File.exist?(@path)
+            contents ||= []
+            contents.each_with_index do |line, index|
+            
+                if line =~ /\A## v?(\d+\.\d+\.\d+)/
+                    header = Changelog::SemanticVersion.new($1)
+
+                    if version == header
+                        entries = markdown.lines
+                        entries.shift(2) # Remove the header and the blank line
+                        entries.pop      # Remove the trailing blank line
+
+                        # Insert the entries below the existing header and its blank line
+                        contents.insert(index + 2, entries)
+                        versions_found = true
+                        
+                        break
+                    elsif version >= header
+                        contents.insert(index, *markdown.lines)
+                        versions_found = true
+
+                        break
+                    end
+
+                end
+
+            end
+
+            contents.push(*markdown.lines) unless versions_found
+
+            contents
+                .flatten
+                .map { |line| line.force_encoding(Encoding::UTF_8) }
+                .join
+
+            File.open(@path, "w") { |f| f.puts contents } unless @dry_run
+            $stdout.puts "#{'CHANGELOG:'.green}\n\n #{contents.join('')}\n" if @dry_run
+            
+        end
+        
+        private
+        
+        def create_file
+            File.open(@path, "w") { |f| f.write header } unless @dry_run
+            $stdout.puts "#{'create'.green} #{@path}" if @dry_run
+
+        end
+
+        def header 
+            str = +""
+            str << "**Note:** This file is automatically generated.\n\n"
+            str << "# Changelog\n\n"
+        end
+    end
+end

data/lib/changelog/version.rb

@@ -0,0 +1,3 @@
+module Changelog
+  VERSION = "1.0.0"
+end

data/lib/changelog.rb

@@ -0,0 +1,9 @@
+require "changelog/version"
+
+module Changelog
+  # Your code goes here...
+
+  def self.say_hi(name)
+    "Hello, Palmer!"
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: changelog-madness
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexandre Joly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-26 00:00:00.000000000 Z
+dependencies:
+- !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: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A tool to create changelog entries and bind them together
+email:
+- alexandre.joly@kilokilo.ch
+executables:
+- changelog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog-madness.gemspec
+- exe/changelog
+- lib/changelog.rb
+- lib/changelog/bundler.rb
+- lib/changelog/cli.rb
+- lib/changelog/entry.rb
+- lib/changelog/generator.rb
+- lib/changelog/helper.rb
+- lib/changelog/markdown_generator.rb
+- lib/changelog/semantic_version.rb
+- lib/changelog/updater.rb
+- lib/changelog/version.rb
+homepage: https://github.com/KiloKilo/changelog
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key: 
+specification_version: 4
+summary: Stop the changelog merge conflict madness
+test_files: []