diff --git a/.docs/README.hbs b/.docs/README.hbs index 69d70b2d7..20892d335 100644 --- a/.docs/README.hbs +++ b/.docs/README.hbs @@ -19,7 +19,7 @@ If you'd like to contribute please take a look at [contribution guide](CONTRIBUT You're reading the README for the master branch of serialport. You probably want to be looking at the README of our latest release. See our [change log](changelog.md) for what's new and our [upgrade guide](UPGRADE_GUIDE.md) for a walk through on what to look out for between major versions. -- [`serialport@5.0.0-beta2` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/5.0.0-beta2/README.md) this is the latest `5.x` releases. +- [`serialport@5.0.0-beta3` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/5.0.0-beta3/README.md) this is the latest `5.x` releases. - [`serialport@4.0.7` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/README.md) it is the latest `4.x` releases. - [`serialport@3.1.2` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/3.1.2/README.md) it was the last `3.x` releases. - [`serialport@2.1.2` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/2.1.2/README.md) it was the last `2.x` release diff --git a/AUTHORS.md b/AUTHORS.md index b4a3a152c..7a50bf73a 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -16,34 +16,35 @@ - Pedro Pereira - deadprogram - Donald Ness -- Julian Gautier -- jgillick -- Seb - Andrew Stewart +- Seb +- jgillick +- Julian Gautier +- fivdi +- arve0 +- Kevin McDermott +- DD - Johannes Rudolph - Elijah Insua +- Munyiri Kamau +- Peter A. Bigot - Vadim Kosarev - Valery De Smedt -- arve0 -- DD -- Kevin McDermott -- Peter A. Bigot -- fivdi -- Munyiri Kamau +- U-Mark-Desktop\Mark - Oliver Schneider -- Mike OShea +- Domenic Denicola - Duane Johnson -- Frederic Hemberger -- Iskren Slavov -- iangregory -- U-Mark-Desktop\Mark - Brian White -- Domenic Denicola - Esa-Matti Suuronen +- Iskren Slavov - Bryan Hughes - Federico Fissore +- Frederic Hemberger +- iangregory +- Mike OShea - Roy Hasson - Sayanee +- Thom Nichols - Thomas Sarlandie - Tim Oxley - Tom Gallacher diff --git a/PUBLISHING.md b/PUBLISHING.md index ce2ef330a..729cdc5a1 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -1,5 +1,4 @@ -How to publish node Serialport -========================================= +# How to publish node Serialport ## Setup for Linux, Windows and OSX @@ -10,19 +9,19 @@ to publish these binaries on Github. This can be checked in the .travis.yml file and appveyor.yml file. Within these files, if a git tag is detected a binary will be built and published for each version. -1. Merge all changes and new features into master. -2. Fill out changelog.md. -3. Bump up npm version *AND* binary host version in `package.json`, commit and push. -4. Update the .docs/README.hbs to reference this current version and to previous major version docs then regenerate docs `npm run docs`. -5. Commit then generate new tags based on package.json version number with `git tag 4.0.4 -a` and include the change log in the tag's annotation. +1. Merge all changes and new features into master +2. Fill out `changelog.md` +3. Bump up npm version in `package.json` +4. Update the `.docs/README.hbs` to reference this current version and to previous major version docs then regenerate docs `npm run docs`. +5. Commit then generate new tags based on package.json version number with `git tag 5.0.0 -a` and include the change log in the tag's annotation. 6. Push tags to Github with `git push --tags` -7. Switch to node v0.12 and npm 2 +7. Switch to node v4 and npm 2 8. `rm -rf node_modules build && npm install` 9. Publish to npm after builds finish. Builds can take half an hour and occasionally fail for seemingly no reason. Restart any failures in the travis or appeveyor ui. While you wait, remove the content of the Github release message so the tag's text shows. When the entire matrix succeeds and all binaries exist run `npm publish`. 10. Kick off the build matrix for either the master or beta branch on [serialport-test-pilot](https://travis-ci.org/j5js/serialport-test-pilot). It will install serialport from npm on a wide range of systems. Differences for beta release -* Tag like: `git tag 4.0.1-beta1 -a` and include the change log in the tag's annotation. +* Tag like: `git tag 5.0.0-beta3 -a` and include the change log in the tag's annotation. * Publish with `npm publish --tag beta` ## Config Travis, AppVeyor and Github to generate all of the binaries. diff --git a/README.md b/README.md index 1cc13d0f3..03c07bdf1 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ If you'd like to contribute please take a look at [contribution guide](CONTRIBUT You're reading the README for the master branch of serialport. You probably want to be looking at the README of our latest release. See our [change log](changelog.md) for what's new and our [upgrade guide](UPGRADE_GUIDE.md) for a walk through on what to look out for between major versions. -- [`serialport@5.0.0-beta2` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/5.0.0-beta2/README.md) this is the latest `5.x` releases. +- [`serialport@5.0.0-beta3` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/5.0.0-beta3/README.md) this is the latest `5.x` releases. - [`serialport@4.0.7` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/README.md) it is the latest `4.x` releases. - [`serialport@3.1.2` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/3.1.2/README.md) it was the last `3.x` releases. - [`serialport@2.1.2` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/2.1.2/README.md) it was the last `2.x` release diff --git a/changelog.md b/changelog.md index c51ecc329..e6623b9e1 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,28 @@ +Version 5.0.0-beta3 +------------- +- [all] Streams rewrite, node serialport is now a node stream! 🎉 +- [all] Introduce a binding layer to provide a common low level interface to work with different platforms. +- [all] add `#get` to retrieve modem status flags thanks to @jgillick! +- [all] Add electron precompiled binaries thanks to @Mike-Dax +- [all] Allow node-pre-gyp path and host to be overridden thanks to @thom-nic +- [all] Conform to NodeJS error message formats +- [all] Drop NodeJS 0.10 and 0.12 support +- [all] Fix baud rate parsing in `serialport-terminal` thanks to @radio-miskovice for reporting it! +- [all] Fix memory leak during opening a port thanks to @indutny +- [all] Refactor internals to make use of es6 and promises +- [all] Remove unnecessary dependencies and polyfills thanks to @mscdex +- [all] Remove v8 deprecation warnings thanks to @indutny again +- [all] Upgrade debug and node-pre-gyp +- [all] Upgrade nan to fix compile issues on some platforms thanks to @thom-nic +- [docs] Add more installation notes on sudo, windows 10, electron and node 7 +- [docs] Mark new features in 5.0.0 with the fact they started in 5.0.0 +- [windows] Fix file handle leak during opens when errors occur thanks to @enami +- [windows] Refactoring of `.list` for Windows so it's significantly smaller thanks to @Zensey +- [windows] Rewrite reading so it's pausable thanks to @munyirik + Version 4.0.7 ------------- -- Fix baud rate parsing in `serialport-terminal` thanks to @radio-miskovice for reporting it! +- [all] Fix baud rate parsing in `serialport-terminal` thanks to @radio-miskovice for reporting it! - [windows] Refactor `SerialPort.list` to be a lot smaller and pickup vendorId, productId and locationId thanks to @zensey for #877! Version 4.0.6 diff --git a/package.json b/package.json index acc0e8ff3..fbaeeb3da 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "serialport", - "version": "5.0.0-beta2", + "version": "5.0.0-beta3", "description": "Node.js package to access serial ports. Welcome your robotic JavaScript overlords. Better yet, program them!", "author": { "name": "Chris Williams",