From 56f614bb1bff279997d70f7b4e4b59ee1ca2f596 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Thu, 4 Aug 2016 09:58:55 -0500 Subject: [PATCH] Add release notes for 1.0 release Change-Id: If0d0921b08edd8a76ea1c42da57ba67c99b1af5d --- README.rst | 1 + .../notes/1.0-summary-47dcce446d6a512b.yaml | 53 +++++++++++++++++++ releasenotes/source/index.rst | 12 ++++- releasenotes/source/unreleased.rst | 5 ++ 4 files changed, 69 insertions(+), 2 deletions(-) create mode 100644 releasenotes/notes/1.0-summary-47dcce446d6a512b.yaml create mode 100644 releasenotes/source/unreleased.rst diff --git a/README.rst b/README.rst index 080660a..1dc8fe9 100644 --- a/README.rst +++ b/README.rst @@ -58,6 +58,7 @@ transition to using osc-lib: * openstackclient.common.session -> osc_lib.session * openstackclient.common.utils -> osc_lib.utils * openstackclient.i18n -> osc_lib.i18n +* openstackclient.shell -> osc_lib.shell Also, some of the test fixtures and modules may be used: diff --git a/releasenotes/notes/1.0-summary-47dcce446d6a512b.yaml b/releasenotes/notes/1.0-summary-47dcce446d6a512b.yaml new file mode 100644 index 0000000..a0375d1 --- /dev/null +++ b/releasenotes/notes/1.0-summary-47dcce446d6a512b.yaml @@ -0,0 +1,53 @@ +--- +prelude: > + ``osc-lib`` was extracted from the main OpenStackClient + repo after the OSC 2.4.0 release. A number of the lower-layer + modules were simply renamed into the osc_lib namespace:: + + * openstackclient.api.api -> osc_lib.api.api + * openstackclient.api.auth -> osc_lib.api.auth + * openstackclient.api.utils -> osc_lib.api.utils + * openstackclient.common.command -> osc_lib.command.command + * openstackclient.common.exceptions -> osc_lib.exceptions + * openstackclient.common.logs -> osc_lib.logs + * openstackclient.common.parseractions -> osc_lib.cli.parseractions + * openstackclient.common.session -> osc_lib.session + * openstackclient.common.utils -> osc_lib.utils + * openstackclient.i18n -> osc_lib.i18n + + The higher-layer components, such as the OpenStackShell and ClientManager + objects, have had significant changes made to them to streamline interaction + with ``os-client-config`` and ``keystoneauth`` in addition to the rename:: + + * openstackclient.common.commandmanager -> osc_lib.command.commandmanager + * openstackclient.shell -> osc_lib.shell + +features: + - Add ``utils.find_min_match()`` function to filter a list + based on a set of minimum values of attributes. For example, + selecting all compute flavors that have a minimum amount of + RAM and disk and VCPUs. + - Add ``cli.client_config.OSC_Config`` as a subclass of + ``os_client_config.config.OpenStackConfig`` to collect all of the + configuration option special cases in OSC into one place and insert + into the ``os-client-config`` handling. +fixes: + - The ``parseractions.KeyValueAction`` class now raises + a ``argparse.ArgumentTypeError`` exception when the + argument is not in the form ``=``. + - Change ``utils.find_resource()`` to handle client managers + that lack a ``find()`` method. Raise an + ``exceptions.CommandError`` exception when multiple matches + are found. + - Change ``utils.find_resource()`` to handle glanceclient's + ``HTTPNotFound`` exception. + - Change ``utils.find_resource()`` to attempt lookups as + IDs first, falling back to ``find()`` methods when available. + - Refactor ``ClientManager`` class to remove OSC-specific logic and + move all option special-cases into ``cli.client_config.OSC_Config``. + Also change some private attributes to public (``region_name``, + ``interface``, ``cacert``, ``verify`` and remove ``_insecure``). + - Refactor ``OpenStackShell`` to handle only global argument + processing and setting up the ClientManager with configuration + from ``os-client-config``. Command and plugin loading remain in + OSC. diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 8f1b155..187d59e 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,14 @@ -============================= +===================== osc-lib Release Notes -============================= +===================== .. toctree:: :maxdepth: 1 + + unreleased + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..cb3cccf --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +===================== +Current Release Notes +===================== + +.. release-notes::