diff --git a/.docs/README.hbs b/.docs/README.hbs index b7c62ee39..f4144e65b 100644 --- a/.docs/README.hbs +++ b/.docs/README.hbs @@ -32,7 +32,7 @@ We're not against firmware but we're better than it. You're reading the README for Node-Serialport's master branch. You probably want to see the README for our most recent release. See our [changelog](CHANGELOG.md) for what's new, and our [upgrade guide](UPGRADE_GUIDE.md) for a walk-through on differences between major versions. -- [`serialport@5.0.0` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/5.0.0/README.md) the latest `5.x` release. 🎉 +- [`serialport@6.0.0-beta1` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/6.0.0-beta1/README.md) the latest `6.x` release. - [`serialport@4.0.7` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/README.md) the latest `4.x` release. - [`serialport@3.1.2` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/3.1.2/README.md) the last `3.x` release. diff --git a/CHANGELOG.md b/CHANGELOG.md index 88000a4f1..dd1c03d3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,32 @@ + +# [6.0.0-beta1](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/5.0.0...6.0.0-beta1) (2017-08-07) + + +### Bug Fixes + +* **linux:** The productID should be a number not a description string ([#1279](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1279)) ([bf46f68](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/bf46f68)) +* **tests:** fixup for [#1279](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1279) ([#1285](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1285)) ([56074f6](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/56074f6)) +* **windows:** Add option to disable RTS ([#1277](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1277)) ([5b8d163](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/5b8d163)) +* **windows:** Parse more types of pnpIds ([#1288](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1288)) ([0b554d7](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/0b554d7)), closes [#1220](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1220) + + +### Chores + +* **binaries:** Lets switch to prebuild! ([#1282](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1282)) ([8c36e99](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/8c36e99)) + + +### Features + +* **test:** tone down codecov comments ([#1289](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1289)) ([749ffac](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/749ffac)) + + +### BREAKING CHANGES + +* **binaries:** I'm considering the switch to `prebuild` a breaking change because it's substantially changes our install processes. It's also possible the install flags to ensure downloading or building from source has changed slightly. That's not our api per say, but it's enough. +* **windows:** We previously hard coded to have RTS on for windows at all times it now default to off. + + + Version 5.0.0 🎉 ------------- Nearly [a year in the making](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/4.0.7...5.0.0-beta9) Node SerialPort 5.0.0 is a major rewrite that improves stability, compatibility and performance. The api surface is similar to version 4 there have been a number of changes to ensure consistent error handling and operation of a serial port. Notably we are now a [`Stream`](https://nodejs.org/api/stream.html)! We can also introduce a bindings layer. A small low level api to provide access to underlying hardware. External bindings written in other languages or targeting other platforms can now be used. diff --git a/PUBLISHING.md b/PUBLISHING.md index 0d0da8103..2b59e5abd 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -9,10 +9,10 @@ We use [prebuild](https://github.com/mafintosh/prebuild) to publish these binari 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 on each platform. 1. Merge all changes and new features into master -2. Run `npm run changelog` and modify `CHANGELOG.md` if needed -3. Bump up npm version in `package.json` +2. Bump up npm version in `package.json` +3. Run `npm run changelog` and modify `CHANGELOG.md` if needed 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 v5.0.0 -a` and include the change log in the tag's annotation. +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. `rm -rf package-lock.json node_modules build && npm install` 8. 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`. diff --git a/README.md b/README.md index 3e4e2e0e0..371ddf8a7 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ We're not against firmware but we're better than it. You're reading the README for Node-Serialport's master branch. You probably want to see the README for our most recent release. See our [changelog](CHANGELOG.md) for what's new, and our [upgrade guide](UPGRADE_GUIDE.md) for a walk-through on differences between major versions. -- [`serialport@5.0.0` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/5.0.0/README.md) the latest `5.x` release. 🎉 +- [`serialport@6.0.0-beta1` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/6.0.0-beta1/README.md) the latest `6.x` release. - [`serialport@4.0.7` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/README.md) the latest `4.x` release. - [`serialport@3.1.2` docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/3.1.2/README.md) the last `3.x` release. diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md index e2f4552c4..ab245234d 100644 --- a/UPGRADE_GUIDE.md +++ b/UPGRADE_GUIDE.md @@ -1,3 +1,11 @@ +Upgrading from 5.x to 6.x +------------- +TLDR: You probably don't have to change anything. You might need to enable `rtscts` in your open options. + +* **binaries:** I'm considering the switch to `prebuild` a breaking change because it's substantially changes our install processes. It's also possible the install flags to ensure downloading or building from source has changed slightly. That's not our api per say, but it's enough. +* **windows:** We previously hard coded to have RTS on for windows at all times it now default to off. + + Upgrading from 4.x to 5.x ------------- Node SerialPort 5.0.0 is a major rewrite that improves stability, compatibility and performance. While the api surface is similar there have been a number of changes to ensure consistent error handling and operation of a serial port. diff --git a/package.json b/package.json index d780755a9..c5ec60752 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "serialport", - "version": "5.1.0-beta5", + "version": "6.0.0-beta1", "description": "Node.js package to access serial ports. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!", "author": { "name": "Chris Williams",