Merge pull request #32 from 4-20ma/31-streamline-changelog

Streamline CHANGELOG entries, eliminate dupes

CHANGELOG.md

@@ -3,70 +3,39 @@
 ## [v4.0.0](https://github.com/4-20ma/I2cDiscreteIoExpander/tree/v4.0.0) (2016-09-24)
 [Full Changelog](https://github.com/4-20ma/I2cDiscreteIoExpander/compare/v3.0.1...v4.0.0)
 
-**Implemented enhancements:**
+IMPROVEMENTS
 
-- Use platformio for travis ci [\#23](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/23)
-- BREAK: Update to IDE 1.5 library format v2.1 [\#30](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/30) ([4-20ma](https://github.com/4-20ma))
-- Use platformio [\#24](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/24) ([4-20ma](https://github.com/4-20ma))
+- \[BREAK\] Update to IDE 1.5 library format v2.1 [\#30](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/30) ([4-20ma](https://github.com/4-20ma))
+- Use PlatformIO for Travis CI [\#24](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/24) ([4-20ma](https://github.com/4-20ma))
 
-**Fixed bugs:**
-
-- Fix Makefile to return mix of .ino, .pde files [\#25](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/25)
-
-**Closed issues:**
-
-- Update CHANGELOG config [\#27](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/27)
-- Adjust .gitignore to add docs/\*.pdf to repo [\#21](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/21)
-
-**Merged pull requests:**
+OTHER
 
 - Update CHANGELOG config [\#29](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/29) ([4-20ma](https://github.com/4-20ma))
-- Fix makefile regex [\#26](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/26) ([4-20ma](https://github.com/4-20ma))
-- Adjust .gitignore [\#22](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/22) ([4-20ma](https://github.com/4-20ma))
+- Exclude /doc/ from repo, remove deprecated pdf docs [\#22](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/22) ([4-20ma](https://github.com/4-20ma))
 
 ## [v3.0.1](https://github.com/4-20ma/I2cDiscreteIoExpander/tree/v3.0.1) (2016-09-13)
 [Full Changelog](https://github.com/4-20ma/I2cDiscreteIoExpander/compare/v3.0.0...v3.0.1)
 
-**Fixed bugs:**
-
-- Fix Rakefile [\#19](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/19)
-
-**Merged pull requests:**
+BUG FIXES
 
-- Fix Rakefile [\#20](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/20) ([4-20ma](https://github.com/4-20ma))
+- Fix Rakefile git remote/origin, add DOXYFILE [\#20](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/20) ([4-20ma](https://github.com/4-20ma))
 
 ## [v3.0.0](https://github.com/4-20ma/I2cDiscreteIoExpander/tree/v3.0.0) (2016-09-13)
 [Full Changelog](https://github.com/4-20ma/I2cDiscreteIoExpander/compare/v2.0.0...v3.0.0)
 
-**Implemented enhancements:**
+IMPROVEMENTS
 
 - Automate changelog [\#16](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/16) ([4-20ma](https://github.com/4-20ma))
-- Change license to Apache 2.0 [\#14](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/14) ([4-20ma](https://github.com/4-20ma))
+- \[BREAK\] Change license to Apache 2.0 [\#14](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/14) ([4-20ma](https://github.com/4-20ma))
 - Add continuous integration testing [\#6](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/6) ([4-20ma](https://github.com/4-20ma))
+- Add Code of Conduct [\#4](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/4) ([4-20ma](https://github.com/4-20ma))
 
-**Fixed bugs:**
-
-- Fix release:default task [\#17](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/17)
-
-**Closed issues:**
-
-- Automate CHANGELOG [\#15](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/15)
-- Change project license to Apache 2.0 [\#13](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/13)
-- Update copyright year, format [\#11](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/11)
-- Remove deprecated INSTALL [\#9](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/9)
-- Synchronize .gitignore [\#7](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/7)
-- Add CI testing [\#5](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/5)
-- Add Code of Conduct [\#2](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/2)
-- Update README [\#1](https://github.com/4-20ma/I2cDiscreteIoExpander/issues/1)
-
-**Merged pull requests:**
+OTHER
 
-- Fix release:default task [\#18](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/18) ([4-20ma](https://github.com/4-20ma))
 - Update copyright, format [\#12](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/12) ([4-20ma](https://github.com/4-20ma))
 - Remove deprecated INSTALL [\#10](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/10) ([4-20ma](https://github.com/4-20ma))
 - Synchronize .gitignore [\#8](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/8) ([4-20ma](https://github.com/4-20ma))
-- Add Code of Conduct [\#4](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/4) ([4-20ma](https://github.com/4-20ma))
-- Update README [\#3](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/3) ([4-20ma](https://github.com/4-20ma))
+- Update README extension, add badges, i2c superscripts [\#3](https://github.com/4-20ma/I2cDiscreteIoExpander/pull/3) ([4-20ma](https://github.com/4-20ma))
 
 ## [v2.0.0](https://github.com/4-20ma/I2cDiscreteIoExpander/tree/v2.0.0) (2013-01-01)
 [Full Changelog](https://github.com/4-20ma/I2cDiscreteIoExpander/compare/v1.0.1...v2.0.0)

Rakefile

@@ -38,7 +38,8 @@ DOXYFILE        = 'Doxyfile'
 GITHUB_USERNAME = '4-20ma'
 GITHUB_REPO     = 'I2cDiscreteIoExpander'
 HEADER_FILE     = "#{GITHUB_REPO}.h"
-CHANGELOG_FILE  = 'CHANGELOG.md'
+CHANGELOG       = 'CHANGELOG'
+CHANGELOG_FILE  = "#{CHANGELOG}.md"
 PROPERTIES_FILE = 'library.properties'
 VERSION_FILE    = Version.version_file('').basename.to_s
 
@@ -58,11 +59,11 @@ task :info do
     $ rake version:bump:major     # or
     edit 'VERSION' file directly
     
-  - Prepare release date, 'CHANGELOG.md' file, documentation:
+  - Prepare release date, '#{CHANGELOG_FILE}' file, documentation:
   
     $ rake prepare
     
-  - Review changes to 'CHANGELOG.md' file
+  - Review changes to '#{CHANGELOG_FILE}' file
     This file is assembled using git commit messages; review for completeness.
   
   - Review html documentation files
@@ -138,21 +139,18 @@ namespace :prepare do
     config.add_issues_wo_labels = false
     config.add_pr_wo_labels = false
     config.enhancement_labels = [
-      'Type: Enhancement'
-    ]
-    config.bug_labels = ['Type: Bug']
-    config.exclude_labels = ['Type: Question']
-    config.header = '# I2cDiscreteIoExpander CHANGELOG'
-    config.include_labels = [
-      'Type: Bug',
       'Type: Enhancement',
-      'Type: Feature Request',
-      'Type: Maintenance'
+      'Type: Feature Request'
     ]
-    # config.since_tag = '0.1.0'
+    config.enhancement_prefix = 'IMPROVEMENTS'
+    config.bug_labels = ['Type: Bug']
+    config.bug_prefix = 'BUG FIXES'
     config.future_release = "v#{Version.current.to_s}"
-    config.user = GITHUB_USERNAME
+    config.header = "# #{GITHUB_REPO} #{CHANGELOG}"
+    config.include_labels = [CHANGELOG]
+    config.merge_prefix = 'OTHER' # e.g. 'Type: Maintenance'
     config.project = GITHUB_REPO
+    config.user = GITHUB_USERNAME
   end # GitHubChangelogGenerator::RakeTask.new
 
   desc 'Update version in library properties file'