diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 535af67..1039f97 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -31,7 +31,7 @@ The following have **NOT** been modified - [ ] doc/ - will be updated upon versioned release - [ ] .ruby-gemset - [ ] .ruby-version +- [ ] CHANGELOG.md - will be updated upon versioned release (HISTORY.md is deprecated) - [ ] Gemfile -- [ ] HISTORY.md - will be updated upon versioned release - [ ] LICENSE - [ ] VERSION - will be updated upon versioned release diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 0000000..9ef326f --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1,9 @@ +add_issues_wo_labels=false +add_pr_wo_labels=false +enhancement-labels=Type: Enhancement,Type: Feature Request +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 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..952b326 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,202 @@ +# 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) + +**Implemented enhancements:** + +- Add continuous integration testing with travis [\#55](https://github.com/4-20ma/ModbusMaster/issues/55) +- Add Code of Conduct [\#54](https://github.com/4-20ma/ModbusMaster/issues/54) +- Create PULL\_REQUEST\_TEMPLATE [\#49](https://github.com/4-20ma/ModbusMaster/issues/49) +- Create ISSUE\_TEMPLATE [\#48](https://github.com/4-20ma/ModbusMaster/issues/48) +- Change license to Apache 2.0 [\#45](https://github.com/4-20ma/ModbusMaster/issues/45) +- Set \_\_MODBUSMASTER\_DEBUG\_\_ to 0 by default [\#35](https://github.com/4-20ma/ModbusMaster/issues/35) +- Pass Stream object instead of integer reference [\#17](https://github.com/4-20ma/ModbusMaster/issues/17) +- Add LICENSE, convert project to Apache 2.0 [\#67](https://github.com/4-20ma/ModbusMaster/pull/67) ([4-20ma](https://github.com/4-20ma)) +- Add example sketch for half-duplex RS485 [\#66](https://github.com/4-20ma/ModbusMaster/pull/66) ([kintel](https://github.com/kintel)) +- Add continuous integration testing with Travis CI [\#63](https://github.com/4-20ma/ModbusMaster/pull/63) ([4-20ma](https://github.com/4-20ma)) +- Add initial .travis.yml configuration [\#62](https://github.com/4-20ma/ModbusMaster/pull/62) ([4-20ma](https://github.com/4-20ma)) +- Add CODE\_OF\_CONDUCT [\#56](https://github.com/4-20ma/ModbusMaster/pull/56) ([4-20ma](https://github.com/4-20ma)) +- Add initial PULL\_REQUEST\_TEMPLATE [\#53](https://github.com/4-20ma/ModbusMaster/pull/53) ([4-20ma](https://github.com/4-20ma)) +- Add initial ISSUE\_TEMPLATE [\#50](https://github.com/4-20ma/ModbusMaster/pull/50) ([4-20ma](https://github.com/4-20ma)) +- Add preTransmission\(\), postTransmission\(\) for half-duplex [\#44](https://github.com/4-20ma/ModbusMaster/pull/44) ([kintel](https://github.com/kintel)) +- Disable \_\_MODBUSMASTER\_DEBUG\_\_ mode by default [\#43](https://github.com/4-20ma/ModbusMaster/pull/43) ([kintel](https://github.com/kintel)) +- Add STYLE coding style guide [\#29](https://github.com/4-20ma/ModbusMaster/pull/29) ([4-20ma](https://github.com/4-20ma)) + +**Closed issues:** + +- Clean up template wording [\#64](https://github.com/4-20ma/ModbusMaster/issues/64) +- Add Label section to CONTRIBUTING [\#60](https://github.com/4-20ma/ModbusMaster/issues/60) +- Update README contact information [\#58](https://github.com/4-20ma/ModbusMaster/issues/58) + +**Merged pull requests:** + +- Clean up ISSUE/PULL\_REQUEST templates [\#65](https://github.com/4-20ma/ModbusMaster/pull/65) ([4-20ma](https://github.com/4-20ma)) +- Add label guidance to CONTRIBUTING [\#61](https://github.com/4-20ma/ModbusMaster/pull/61) ([4-20ma](https://github.com/4-20ma)) +- Update README contact information [\#59](https://github.com/4-20ma/ModbusMaster/pull/59) ([4-20ma](https://github.com/4-20ma)) +- Add email address to CODE\_OF\_CONDUCT [\#57](https://github.com/4-20ma/ModbusMaster/pull/57) ([4-20ma](https://github.com/4-20ma)) +- Clarify instructions in ISSUE\_TEMPLATE [\#52](https://github.com/4-20ma/ModbusMaster/pull/52) ([4-20ma](https://github.com/4-20ma)) +- Add ISSUE\_TEMPLATE title reqs, separator lines [\#51](https://github.com/4-20ma/ModbusMaster/pull/51) ([4-20ma](https://github.com/4-20ma)) + +## [v0.11.0](https://github.com/4-20ma/ModbusMaster/tree/v0.11.0) (2015-05-22) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.10.3...v0.11.0) + +**Implemented enhancements:** + +- Update architecture switch to match Arduino convention [\#27](https://github.com/4-20ma/ModbusMaster/issues/27) + +## [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) + +**Closed issues:** + +- 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) + +## [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) + +**Fixed bugs:** + +- Fix documentation build error [\#16](https://github.com/4-20ma/ModbusMaster/issues/16) + +**Closed issues:** + +- 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) + +## [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) + +## [v0.9](https://github.com/4-20ma/ModbusMaster/tree/v0.9) (2011-12-27) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.8...v0.9) + +## [v0.8](https://github.com/4-20ma/ModbusMaster/tree/v0.8) (2011-11-09) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.7...v0.8) + +## [v0.7](https://github.com/4-20ma/ModbusMaster/tree/v0.7) (2010-02-10) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.6...v0.7) + +## [v0.6](https://github.com/4-20ma/ModbusMaster/tree/v0.6) (2010-02-05) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.5...v0.6) + +## [v0.5](https://github.com/4-20ma/ModbusMaster/tree/v0.5) (2010-01-30) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.4...v0.5) + +## [v0.4](https://github.com/4-20ma/ModbusMaster/tree/v0.4) (2010-01-30) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.3...v0.4) + +## [v0.3](https://github.com/4-20ma/ModbusMaster/tree/v0.3) (2010-01-29) +[Full Changelog](https://github.com/4-20ma/ModbusMaster/compare/v0.2...v0.3) + +## [v0.2](https://github.com/4-20ma/ModbusMaster/tree/v0.2) (2010-01-26) +[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) + + +## [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)* \ No newline at end of file diff --git a/Gemfile b/Gemfile index f52ad4c..9ed6466 100644 --- a/Gemfile +++ b/Gemfile @@ -19,6 +19,7 @@ source 'https://rubygems.org' # place general project gems in this section (alphabetical order) ____________ gem 'git', '~> 1.3.0' # git management +gem 'github_changelog_generator', '~> 1.13.1' gem 'rake', '~> 11.2.2' gem 'version', '~> 1.0.0' # version management gem diff --git a/Gemfile.lock b/Gemfile.lock index 43ff8ea..cdec147 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,8 +1,37 @@ GEM remote: https://rubygems.org/ specs: + addressable (2.4.0) + colorize (0.8.1) + descendants_tracker (0.0.4) + thread_safe (~> 0.3, >= 0.3.1) + faraday (0.9.2) + multipart-post (>= 1.2, < 3) git (1.3.0) + github_api (0.14.5) + addressable (~> 2.4.0) + descendants_tracker (~> 0.0.4) + faraday (~> 0.8, < 0.10) + hashie (>= 3.4) + oauth2 (~> 1.0) + github_changelog_generator (1.13.1) + colorize (~> 0.7) + github_api (~> 0.12) + rake (>= 10.0) + hashie (3.4.4) + jwt (1.5.4) + multi_json (1.12.1) + multi_xml (0.5.5) + multipart-post (2.0.0) + oauth2 (1.2.0) + faraday (>= 0.8, < 0.10) + jwt (~> 1.0) + multi_json (~> 1.3) + multi_xml (~> 0.5) + rack (>= 1.2, < 3) + rack (2.0.1) rake (11.2.2) + thread_safe (0.3.5) version (1.0.0) PLATFORMS @@ -10,6 +39,7 @@ PLATFORMS DEPENDENCIES git (~> 1.3.0) + github_changelog_generator (~> 1.13.1) rake (~> 11.2.2) version (~> 1.0.0) diff --git a/HISTORY.md b/HISTORY.md index 611aefb..bd9b260 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,3 +1,7 @@ + ## [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