Skip to content

Commit

Permalink
Bump to 4.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
reconbot committed Jul 2, 2016
1 parent 97c302a commit b5da11c
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
5 changes: 2 additions & 3 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,15 @@ This can be checked in the .travis.yml file and appveyor.yml file. Within these
2. Fill out changelog.md.
3. Bump up npm version *AND* binary host version in `package.json`, commit and push.
4. Update the README.md to reference this current version and to previous major version docs.
5. Generate new tags based on package.json version number with `git tag 2.0.7 -a` and include the change log in the tag's annotation.
5. Generate new tags based on package.json version number with `git tag 4.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
8. `rm -rf node_modules && npm install`
9. Publish to npm. BUT NOT YET. Builds can an hour and occasionally fail (mainly on Appveyor) for seemingly no reason. Restart any failures in the travis or appeveyor ui. While you wait, copy the changelog updates into the Github release field. 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 2.0.7-beta1 -a` and include the change log in the tag's annotation.
* Tag like: `git tag 4.0.1-beta1 -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.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,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.

- [`[email protected]-rc1` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.0-rc1/README.md) it is the latest `4.x` releases.
- [`[email protected]` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.0/README.md) it is the latest `4.x` releases.
- [`[email protected]` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/3.1.2/README.md) it is the latest `3.x` releases.
- [`[email protected]` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/2.1.2/README.md) it was the last `2.x` release
- [`[email protected]` docs are here](https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/v1.7.4/README.md) it was the last `1.x` release
Expand Down
14 changes: 7 additions & 7 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
Version 4.0.0-rc1
Version 4.0.0
-------------
- Requiring `serialport` now returns the SerialPort constructor function instead of a factory object. `SerialPort.SerialPort` is now depreciated.
- `SerialPort` constructor now throws on argument errors immediately.
- `.write(writeCallback)` now only calls it's callback once after the entire write operation, it used to be called for each write cycle and return the bytes written. This reduces the number of callbacks by hundreds of thousands over a megabyte at low bandwidth.
- Disconnections now always attempt to close the port, and you'll always get a `close` event after a `disconnect` event
- All callbacks are called in the context of the port, `this` now equals the port.
- Removed `openImmediately` from the constructor's api, the functionality is now named `autoOpen` on the options object.
- Removed extraneous flow control settings from the `flowControl` option, use the specific options to set these flags now.
- Removed undocumented callbacks from the options object `disconnectedCallback` and `dataCallback`
- `.write(writeCallback)` now only calls it's callback once after the entire write operation, it used to be called for each write cycle and return the bytes written. This reduces the number of callbacks by hundreds of thousands over a megabyte at low bandwidth.
- All callbacks are called in the context of the port, `this` now equals the port.
- Disconnections now always attempt to close the port, and you'll always get a `close` event after a `disconnect` event
- Reanmed `serialportlist` to `serialport-list`
- Renamed `serialportlist` to `serialport-list`
- Renamed `serialportterm` to `serialport-term`
- Added a contributors guide
- Added our first Arduino required integration tests
- [unix] `.drain` and `.set` now properly report errors
- [unix] Ports are now locked by default with the new `lock` options matches windows default behavior
- [windows] `.update()` now supports windows for changing baud rates
- [windows] Fixed a bug where we weren't properly opening ports (provides better support virtual com ports too) thanks to @RogerHardiman
- [windows] known issue `lock: false` doesn't work (no change in behavior)
- Added our first arduino required integration tests
- Added a contributors guide

Version 3.1.2
-------------
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "serialport",
"version": "4.0.0-rc1",
"version": "4.0.0",
"description": "Node.js package to access serial ports. Welcome your robotic javascript overlords. Better yet, program them!",
"author": {
"name": "Chris Williams",
Expand All @@ -10,7 +10,7 @@
"binary": {
"module_name": "serialport",
"module_path": "build/{configuration}/",
"host": "https://github.com/EmergingTechnologyAdvisors/node-serialport/releases/download/4.0.0-rc1"
"host": "https://github.com/EmergingTechnologyAdvisors/node-serialport/releases/download/4.0.0"
},
"main": "./lib/serialport",
"repository": {
Expand Down

0 comments on commit b5da11c

Please sign in to comment.