From a113856a27b57a7708c9c4ec698cef0d7cfdc499 Mon Sep 17 00:00:00 2001 From: mihaiparvu Date: Wed, 24 Oct 2018 10:56:44 +0300 Subject: [PATCH] Release notes and updated version for 3.2.0a1 --- docs/SSHLibrary-3.2.0a1.rst | 107 ++++++++++++++++++++++++++++++++++++ src/SSHLibrary/version.py | 2 +- 2 files changed, 108 insertions(+), 1 deletion(-) create mode 100644 docs/SSHLibrary-3.2.0a1.rst diff --git a/docs/SSHLibrary-3.2.0a1.rst b/docs/SSHLibrary-3.2.0a1.rst new file mode 100644 index 000000000..87db16406 --- /dev/null +++ b/docs/SSHLibrary-3.2.0a1.rst @@ -0,0 +1,107 @@ +======================== +SSHLibrary 3.2.0 alpha 1 +======================== + + +.. default-role:: code + + +SSHLibrary_ is a `Robot Framework`_ test library for SSH and SFTP. +SSHLibrary 3.2.0a1 is a new release with several enhancements and bug fixes. +All issues targeted for SSHLibrary v3.2.0 can be found from +the `issue tracker`_. + +If you have pip_ installed, just run + +:: + + pip install --pre --upgrade robotframework-sshlibrary + +to install the latest release or use + +:: + + pip install robotframework-sshlibrary==3.2.0a1 + +to install exactly this version. Alternatively you can download the source +distribution from PyPI_ and install it manually. + +SSHLibrary 3.2.0a1 was released on Wednesday October 24, 2018. + +.. _Robot Framework: http://robotframework.org +.. _SSHLibrary: https://github.com/robotframework/SSHLibrary +.. _pip: http://pip-installer.org +.. _PyPI: https://pypi.python.org/pypi/robotframework-sshlibrary +.. _issue tracker: https://github.com/robotframework/SSHLibrary/issues?q=milestone%3Av3.2.0 + + +.. contents:: + :depth: 2 + :local: + +Most important enhancements +=========================== + +The most important new features of SSHLibrary 3.2.0 are the new timeout +argument for `Execute Command` (`#127`_) and adding the option to strip +the prompt for `Read Until Prompt` keyword, similar with Telnet library +(`#247`_). + +Backwards incompatible changes +============================== + +The `Close Connection` keyword removes the connection from the alias list and +trying to switch to a closed connection will now result in keyword failure (`#233`_). + +Acknowledgements +================ + +Great contributions for the following issues from Claudiu Dragan: + +- Add *timeout* setting to `Execute Command` (`#127`_) +- Add *strip_prompt* argument to the `Read Until Prompt` keyword (`#247`_) + +Full list of fixes and enhancements +=================================== + +.. list-table:: + :header-rows: 1 + + * - ID + - Type + - Priority + - Summary + - Added + * - `#266`_ + - bug + - high + - Get File keyword IOError when trying to copy symbolic link + - alpha 1 + * - `#260`_ + - bug + - medium + - Get/Put File keywords do not return folders containing square brackets + - alpha 1 + * - `#127`_ + - enhancement + - medium + - Add timeout setting to 'Execute Command' + - alpha 1 + * - `#247`_ + - enhancement + - medium + - Add strip_prompt argument to the Read Until Prompt keyword + - alpha 1 + * - `#233`_ + - bug + - low + - "Close Connection" keyword does not remove the connection from existing connections + - alpha 1 + +Altogether 5 issues. View on the `issue tracker `__. + +.. _#266: https://github.com/robotframework/SSHLibrary/issues/266 +.. _#260: https://github.com/robotframework/SSHLibrary/issues/260 +.. _#127: https://github.com/robotframework/SSHLibrary/issues/127 +.. _#247: https://github.com/robotframework/SSHLibrary/issues/247 +.. _#233: https://github.com/robotframework/SSHLibrary/issues/233 diff --git a/src/SSHLibrary/version.py b/src/SSHLibrary/version.py index d6df25229..b12c4ce29 100644 --- a/src/SSHLibrary/version.py +++ b/src/SSHLibrary/version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -VERSION = '3.1.2.dev1' +VERSION = '3.2.0a1'