From: Dan Scott Date: Mon, 28 May 2012 02:52:23 +0000 (-0400) Subject: 2.1.0 release notes in progress X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=758ffb50a842be5f6ece3817fea5f07871c5aba2;p=working%2FOpenSRF.git 2.1.0 release notes in progress Gotta have release notes before you release... WIP Signed-off-by: Dan Scott --- diff --git a/doc/RELEASE_NOTES.txt b/doc/RELEASE_NOTES.txt new file mode 100644 index 0000000..d8fabf9 --- /dev/null +++ b/doc/RELEASE_NOTES.txt @@ -0,0 +1,112 @@ +e7431d6 Detect and repair multipart/mixed message delivery errors +832f166 fix up index/position type for calls of various osrfList* functions +bdc4cfe Remove comparisons that can never evaluate to true +3aabf19 LP954059: Silence uninitialized var warning +4fe1fdc LP# 953299 - defend against null and zero-length cache keys +3e97b0f LP# 953299 - Prevent get/set of invalid cache keys +d9487c4 Clean up root directory: INSTALL, .gitignore, autoreconf +cf4d479 Prevent undef warnings on perl socket read nbytes test +f470b55 Detect remote disconnect in Perl XMPP reader +974d3a0 Protect gateway from format-string crashes in data +fd92a85 Stop warning about missing parentheses... +8cfa0ae Refresh child file handles on status read +aeeb4ac Perl parent/child write improvements +08ee4f9 Perl pipe reading overhaul : data size header +04558f3 JSON_v0 has been superseded, and it has insidious bugs anyway. +89f41c8 Sync parent/child write/read with lock file +a7be31f Add SIGPIPE retry handling to child data sysread +40a753b LP878284: stop_osrf action should stop, not start, Perl +0725d1d Don't define a variable inside a conditional block +4e7f49a Teach Perl Makefile to build Build for every target +47d4ebf Comment on why we're pulling in version.m4 +19431b8 Define version number in one place +d514307 Inline TestObject for net_obj_test.py as well +9cb5912 Fix unit tests for Python in a twistd instance +5b68d68 Add Python unit testing and coverage report to "make check" + +Supported platforms +------------------- +The following Linux distributions are supported as of OpenSRF 2.1.0: + + * Debian 6 (Squeeze) + * Fedora 16, 17 + * Ubuntu 10.04 LTS (Karmic Koala), 12.04 LTS (Precise Pangolin) + +The following platforms are *no longer* supported: + + * CentOS 5 + * Debian 5 (Lenny) + * Fedora 14 and 15 + * RHEL 5 + +New features +------------ + +OpenSRF Validator service (`opensrf.validator`) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The new `opensrf.validator` service offers a home for common validation +routines. It includes two validators for email addresses: + + * OpenSRF::Application::Validator::EmailAddress::Regex - validates an email + address using a basic regular expression + * OpenSRF::Application::Validator::EmailAddress::DNS - validates the domain + of an email address + +Ingress tracking +^^^^^^^^^^^^^^^^ +To provide more granular logging of OpenSRF activity, the 'ingress' (or 'entry +point') for an OpenSRF client can now be tracked. The default value of the +`ingress` property is `opensrf`, but other likely values include `srfsh`, +`translator-v1`, and `gateway-v1`. + +Java HTTP gateway client +^^^^^^^^^^^^^^^^^^^^^^^^ +Support has been added to the Java OpenSRF libraries for communicating with the +OpenSRF HTTP gateway via the `org.opensrf.net.http` package. + +Example Nagios plugin +^^^^^^^^^^^^^^^^^^^^^ +An example Nagios plugin that checks every defined service for a brick for a +response has been added at `examples/nagios/check_osrf_services`. + +Log warnings for large XMPP messages +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +As ejabberd disconnects clients when sending very large messages, write a log +message when the XMPP message will exceed the default threshold of 1,800,000 +bytes. This threshold can be modified via the `` element in +the `opensrf_core.xml` configuration file. + +Documentation improvements +-------------------------- +The `INSTALL` file in the root directory is now the canonical guide to +installing and configuring OpenSRF. + +Build improvements +------------------ +The source directory is now bootstrapped via the standard `autoreconf -i` +autotools command, rather than the old `autogen.sh` command. + +Dependencies for OpenSRF's Java libraries have been updated to reflect modern +Java. + +The `DESTDIR` variable is respected at build time to better support distribution +packaging efforts. + +Testing +------- +The new `make check` target will run all unit tests across C, Perl, and Python. + +Unit tests +^^^^^^^^^^ +Various unit tests have been added to Python + +Continuous integration support +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +An example configuration file for the http://buildbot.net/[Buildbot] continuous +integration server can be found in `examples/buildbot.cfg`. The most current +version of this file will always be found in the `master` branch of the OpenSRF +git repository. + +The build steps configure and compile the code using the default arguments to +`configure`, as well as running the unit tests for C, Perl, and Python, and +running `pylint` against the Python source code.