Update CHANGELOG with github_changelog_generator

Author: 4-20ma

.github_changelog_generator

@@ -5,5 +5,4 @@ bug-labels=Type: Bug
 exclude-labels=Type: Question
 header=# ModbusMaster CHANGELOG
 include-labels=Type: Bug,Type: Enhancement,Type: Feature Request,Type: Maintenance
-since-tag=0.10.0
 future-release=Unreleased

CHANGELOG.md

@@ -1,7 +1,7 @@
 # ModbusMaster CHANGELOG
 
-## [Unreleased](https://github.com/4-20ma/ModbusMaster/tree/Unreleased) (2016-09-11)
-[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.11.0...Unreleased)
+## [v0.12.0](https://github.com/4-20ma/ModbusMaster/tree/v0.12.0) (2016-09-11)
+[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.11.0...v0.12.0)
 
 **Implemented enhancements:**
 
@@ -44,6 +44,8 @@
 **Implemented enhancements:**
 
 - Update architecture switch to match Arduino convention [\#27](https://github.com/4-20ma/ModbusMaster/issues/27)
+- Request timeout is impatient [\#3](https://github.com/4-20ma/ModbusMaster/issues/3)
+- Update architecture switch [\#28](https://github.com/4-20ma/ModbusMaster/pull/28) ([4-20ma](https://github.com/4-20ma))
 
 ## [v0.10.3](https://github.com/4-20ma/ModbusMaster/tree/v0.10.3) (2015-05-22)
 [Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.10.2...v0.10.3)
@@ -53,17 +55,28 @@
 - Inconsistent Doxygen comments [\#25](https://github.com/4-20ma/ModbusMaster/issues/25)
 - Replace C macros with inline functions [\#18](https://github.com/4-20ma/ModbusMaster/issues/18)
 
+**Merged pull requests:**
+
+- Adjust doxygen comments to be consistent [\#26](https://github.com/4-20ma/ModbusMaster/pull/26) ([4-20ma](https://github.com/4-20ma))
+- Replace C macros w/inline functions [\#24](https://github.com/4-20ma/ModbusMaster/pull/24) ([4-20ma](https://github.com/4-20ma))
+
 ## [v0.10.2](https://github.com/4-20ma/ModbusMaster/tree/v0.10.2) (2015-05-22)
 [Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.9.1...v0.10.2)
 
+**Implemented enhancements:**
+
+- Implement CRC16 for SAM3X8E microprocessor [\#11](https://github.com/4-20ma/ModbusMaster/pull/11) ([4-20ma](https://github.com/4-20ma))
+- Add rx flush, change response timeout to 2000 ms [\#10](https://github.com/4-20ma/ModbusMaster/pull/10) ([agprimatic](https://github.com/agprimatic))
+
 **Fixed bugs:**
 
-- Fix documentation build error [\#16](https://github.com/4-20ma/ModbusMaster/issues/16)
+- Fix documentation build error [\#23](https://github.com/4-20ma/ModbusMaster/pull/23) ([4-20ma](https://github.com/4-20ma))
+- Work around HardwareSerial for SAM3 micro [\#12](https://github.com/4-20ma/ModbusMaster/pull/12) ([4-20ma](https://github.com/4-20ma))
 
-**Closed issues:**
+**Merged pull requests:**
 
-- Rename markdown file extensions [\#20](https://github.com/4-20ma/ModbusMaster/issues/20)
-- Update pointers to match C++ convention [\#15](https://github.com/4-20ma/ModbusMaster/issues/15)
+- Update pointers to match C++ convention [\#22](https://github.com/4-20ma/ModbusMaster/pull/22) ([4-20ma](https://github.com/4-20ma))
+- Rename markdown file extensions [\#21](https://github.com/4-20ma/ModbusMaster/pull/21) ([4-20ma](https://github.com/4-20ma))
 
 ## [v0.9.1](https://github.com/4-20ma/ModbusMaster/tree/v0.9.1) (2013-01-02)
 [Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.9...v0.9.1)
@@ -93,110 +106,6 @@
 [Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.1...v0.2)
 
 ## [v0.1](https://github.com/4-20ma/ModbusMaster/tree/v0.1) (2010-01-25)
-[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/0.10.0...v0.1)
-
-<!--
-This file is no longer maintained; refer to CHANGELOG.md, which automatically
-incorporates appends content from this file.
--->
-## [v0.11.0 (2015-05-22)](https://github.com/4-20ma/ModbusMaster/tree/v0.11.0)
-- Fix grammar in library.properties
-- Fix broken links in HISTORY, Rakefile
-- Add RX flush, increase response timeout
-- Insert missing space
-- Add comment clarifying flush() is tx buffer only
-- Fix MBSerial pointer from . to ->
-- Update architecture switch
-
-
-## [v0.10.3 (2015-05-22)](https://github.com/4-20ma/ModbusMaster/tree/v0.10.3)
-- Adjust doxygen comments to be consistent
-- Replace C macros w/inline functions
-- Update library.properties to conform to others
-- Adjust README links to use absolute URLs
-
-
-## [v0.10.2 (2015-05-21)](https://github.com/4-20ma/ModbusMaster/tree/v0.10.2)
-- Update documentation after resolving doc build err
-- Fix documentation build error
-- Update library.properties
-- Add README badges for tag, license
-- Update README
-    - Replace **Heading** with Heading followed by ------- line for cleaner Markdown syntax
-    - Update Arduino version note to 1.6
-    - Fix nanoline URL
-- Remove deprecation note from README
-- Update pointers to match C++ convention
-- Rename markdown file extensions
-
-
-## v0.10.1 (2015-05-20)
-- Update Rakefile to commit Doxyfile, reference
-- Version bump to v0.10.0
-
-
-## v0.10.0 (2015-05-20)
-- Update Rakefile to update library.properties
-- Add library.properties file to describe library
-- Add .ruby-* to manage versions via rvm or rbenv
-- Add Gemfile to manage dependencies via Bundler
-- Update .gitignore to exclude Gemfile.lock
-- Work around HardwareSerial for SAM3 micro
-    - add #ifdefs to check for presence of AVR or ARM chipset (use HardwareSerial for AVR and UARTClass for ARM)
-    - change MBSerial to pointer and update all references to use -> notation instead of . notation
-- Implement CRC16 for SAM3X8E microprocessor
-    - renamed _crc16_update to crc16_update to minimize confusion with AVR function in util/crc16.h
-    - added C version of crc16 and removed extraneous version of crc16 functions
-- Add end-of-life note to README
-- Add auto-generated pdf documentation for v0.9.1
-- Remove pdf documentation for versions 0.6, 0.7
-- Add pdf documentation for versions 0.6, 0.7
-- Remove unnecessary require 'fileutils'
-- Add auto-generated pdf documentation
-- Define PROJECT_BRIEF tag in Doxyfile
-- Add pdf generation to prepare:documentation
-- Add doc/README.txt
-
-
-## [v0.9.1 (2013-01-02)](https://github.com/4-20ma/ModbusMaster/tree/v0.9.1)
-- Add Rakefile to manage prepare/release process
-- Add .gitignore to skip doc/html, doc/latex files
-- Add Doxyfile to repo
-- Update copyright year
-- Update email address
-- Fix references to repo
-- Move history to separate file
-- Update README copyright, email
-
-
-## [v0.9 (2011-12-04)](https://github.com/4-20ma/ModbusMaster/tree/v0.9)
-- Add support for Arduino 1.0
-
-
-## [v0.8 (2011-11-09)](https://github.com/4-20ma/ModbusMaster/tree/v0.8)
-- Add support for ATmega2560
-
-
-## [v0.7 (2010-02-09)](https://github.com/4-20ma/ModbusMaster/tree/v0.7)
-- Modified capitalization of functions to match Arduino style where first letter is lower-case
-
-
-## [v0.6 (2010-02-04)](https://github.com/4-20ma/ModbusMaster/tree/v0.6)
-- Added documentation via Doxygen comments, modified methods used to get/set storage buffers
-
-
-## [v0.5 (2010-01-30)](https://github.com/4-20ma/ModbusMaster/tree/v0.5)
-- Added ability to select serial port 0..3, modified methods used to get/set storage arrays, miscellaneous bug fixes
-
-
-## [v0.3 (2010-01-29)](https://github.com/4-20ma/ModbusMaster/tree/v0.3)
-
-
-## [v0.2 (2010-01-25)](https://github.com/4-20ma/ModbusMaster/tree/v0.2)
-
-
-## [v0.1 (2010-01-24)](https://github.com/4-20ma/ModbusMaster/tree/v0.1)
-- Initial public release
 
 
 \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

Rakefile

@@ -16,6 +16,7 @@
 #
 
 require 'git'
+require 'github_changelog_generator/task'
 require 'rake'
 require 'rubygems'
 require 'rake/version_task'         # gem install version
@@ -32,7 +33,7 @@ DOXYFILE        = 'Doxyfile'
 GITHUB_USERNAME = '4-20ma'
 GITHUB_REPO     = 'ModbusMaster'
 HEADER_FILE     = "#{GITHUB_REPO}.h"
-HISTORY_FILE    = 'HISTORY.md'
+CHANGELOG_FILE  = 'CHANGELOG.md'
 PROPERTIES_FILE = 'library.properties'
 VERSION_FILE    = Version.version_file('').basename.to_s
 
@@ -72,14 +73,14 @@ task :info do
 end # task :info
 
 
-desc 'Prepare HISTORY file for release'
+desc "Prepare #{CHANGELOG_FILE} for release"
 task :prepare => 'prepare:default'
 
 namespace :prepare do
   task :default => [
     :release_date,
     :library_properties,
-    :history,
+    :changelog,
     :documentation
   ]
 
@@ -110,28 +111,27 @@ namespace :prepare do
   end # task :documentation
 
   desc 'Prepare release history'
-  task :history, :tag do |t, args|
-    g = Git.open(CWD)
-
-    current_tag = args[:tag] || Version.current.to_s
-    prior_tag = g.tags.last
-
-    history = "## [v#{current_tag} (#{Time.now.strftime('%Y-%m-%d')})]"
-    history << "(https://github.com/#{GITHUB_USERNAME}/#{GITHUB_REPO}/tree"
-    history << "/v#{current_tag})\n"
-
-    commits = prior_tag ? g.log.between(prior_tag) : g.log
-    history << commits.map do |commit|
-      "- #{commit.message}"
-    end.join("\n")
-    history << "\n\n---\n"
-
-    file = File.join(CWD, HISTORY_FILE)
-    puts "Updating file #{file}:"
-    puts history
-    contents = IO.read(file)
-    IO.write(file, history << contents)
-  end # task :history
+  GitHubChangelogGenerator::RakeTask.new(:changelog) do |config|
+    config.add_issues_wo_labels = false
+    config.add_pr_wo_labels = false
+    config.enhancement_labels = [
+      'Type: Enhancement',
+      'Type: Feature Request'
+    ]
+    config.bug_labels = ['Type: Bug']
+    config.exclude_labels = ['Type: Question']
+    config.header = '# ModbusMaster CHANGELOG'
+    config.include_labels = [
+      'Type: Bug',
+      'Type: Enhancement',
+      'Type: Feature Request',
+      'Type: Maintenance'
+    ]
+    # config.since_tag = '0.1.0'
+    config.future_release = "v#{Version.current.to_s}"
+    config.user = GITHUB_USERNAME
+    config.project = GITHUB_REPO
+  end # GitHubChangelogGenerator::RakeTask.new
 
   desc 'Update version in library properties file'
   task :library_properties do
@@ -196,7 +196,7 @@ namespace :release do
   task :source do
     version = Version.current.to_s
     `git add doc/#{DOXYFILE} "doc/#{GITHUB_REPO} reference-#{version}.pdf" \
-      #{HEADER_FILE} #{HISTORY_FILE} #{PROPERTIES_FILE} #{VERSION_FILE}`
+      #{HEADER_FILE} #{CHANGELOG_FILE} #{PROPERTIES_FILE} #{VERSION_FILE}`
     `git commit -m 'Version bump to v#{version}'`
     `git tag -a -f -m 'Version v#{version}' v#{version}`
     `git push origin master`