RELEASE_NOTES.md in riak-client-1.4.5 vs RELEASE_NOTES.md in riak-client-2.0.0.rc1
- old
+ new
@@ -1,73 +1,48 @@
# Riak Ruby Client Release Notes
-## 1.4.5 Feature and Bugfix Release - 2014-10-03
+## 2.0.0 Release - TBD
-Release 1.4.5 includes:
+Version 2.0.0 is a major new version with many new features, API changes,
+and feature removals.
-Feature:
+New features:
-* Instrumentation: if the `instrumentable` gem is loaded, the client exposes
- several event hooks to `ActiveSupport::Notifications`. Read the README for
- more information, and if you'd like other events to be instrumented, please
- file GitHub issues. Instrumentation was developed by Ryan Daigle.
+* Yokozuna: full-text search built on Solr and powered by Riak.
+* Riak security: TLS-encrypted and authenticated protocol buffers, access
+ control, and more!
+* Convergent Replicated Data Types (CRDTs): counters, maps, and sets, all with
+ convenient and safe distributed semantics.
+* Bucket types: the building blocks of Yokozuna, access control, and CRDTs.
-Bugfix:
+API changes:
-* URI escaping now uses the CGI escaper. Thanks to Sean McKibben for
- reporting this bug.
+* Exceptions raised by the client are subclasses of `Riak::Error`.
+* The internals of the Beefcake-based protocol buffers support have been
+ refactored for reliability and maintainability.
+* The Beefcake version has been bumped to 1.0 for improvements in speed and
+ memory usage.
+* Tests now use RSpec 3.
-## 1.4.4.1 Bugfix Release - 2014-04-17
+Removed:
-Release 1.4.4.1 includes the intended 1.4.4 bugfix:
+* HTTP support has been removed from the Riak Ruby Client in favor of focusing
+ on Protocol Buffers.
+* The included test-server has been removed. Tests now require a Riak node to
+ be configured and run independently of the test suite.
-* Remove freedom-patched `Net::HTTPHeader#each_capitalized` method. This
- caused infinite loops when parsing HTTP headers not related to Riak,
- and is not necessary in Riak versions newer than 1.1.0. Thanks to
- Morten Primdahl and Steven Davidovitz at Zendesk for helping isolate and
- troubleshoot this.
-
-## 1.4.4 - 2014-04-17
-
-No changes from 1.4.3.
-
-## 1.4.3 Bugfix Release - 2013-12-31
-
-Release 1.4.3 fixes some bugs and improves documentation.
-
-Documentation:
-* Secondary Index examples in README now use string names.
-* 1.4 Counter usage explained better, fixed by Srdjan "batasrki" Pejic in
- https://github.com/basho/riak-ruby-client/pull/130
-
-Bugfixes:
-
-* Redundant `gem "rake"` in `Gemfile`.
-* Escape square brackets in key names, reported and fixed by Garret Alfert in
- https://github.com/basho/riak-ruby-client/issues/128 and
- https://github.com/basho/riak-ruby-client/pull/129 , respectively.
-
-
## 1.4.2 Bugfix Release - 2013-09-20
Release 1.4.2 fixes a couple bugs.
-Issues:
-
-* Secondary index queries against non-2i-enabled buckets/backends now raise a
- useful exception.
-
Bugfixes:
* 2i Requests over PBC block forever when 0 results match in 1.4.x,
reported by Sean "graphex" McKibben in
https://github.com/basho/riak-ruby-client/pull/121 and
https://github.com/basho/riak-ruby-client/pull/122
* RObject#links is an Array when loaded from PBC, reported by Dan Pisarski in
https://github.com/basho/riak-ruby-client/pull/123
-* Bucket listing doesn't work with HTTP backend,
- reported and fixed by Wagner Camaro in
- https://github.com/basho/riak-ruby-client/pull/124
## 1.4.1 Patch/Bugfix Release - 2013-09-06
Release 1.4.1 fixes a few minor bugs and issues.