Просмотр исходного кода

First pass at v1.0.0 changelog; update release process notes

Enis Afgan 7 лет назад
Родитель
Сommit
89360da38e
2 измененных файлов с 41 добавлено и 10 удалено
  1. 31 3
      CHANGELOG.rst
  2. 10 7
      docs/topics/release_process.rst

+ 31 - 3
CHANGELOG.rst

@@ -1,3 +1,31 @@
+1.0.0 - Aug ??, 2018. (sha ??)
+-------
+
+* Added Microsoft Azure as a provider
+* Restructured the interface to make it more comprehensible and uniform across
+  all supported providers. See `issue #69 <https://github.com/CloudVE/cloudbridge/issues/69>`_
+  for more details as well as the library layout image for an easy visual
+  reference: http://cloudbridge.cloudve.org/en/v1.0.0/#quick-reference.
+* Migrated AWS implementation to use boto3 library from boto (thanks @01000101)
+* Cleaned up use of ``name`` property for resources. Resources now have ``id``,
+  ``name``, and ``label`` properties to represent respectively: a unique
+  identifier supplied by the provider; a descriptive, unchangeable name; and a
+  user-supplied label that can be modified during the existence of a resource.
+* Added enforcement of name and label value: names must be less than 64 chars
+  in length and consist of only lower case letters and dashes
+* Refactored tests and extracted standard interface tests where all resources
+  are being tested using the same code structure. Also, tests will run only
+  for providers that implement a given service.
+* When deleting an OpenStack network, clear any ports
+* Added support for launching OpenStack instances into a specific subnet
+* Update image list interface to allow filtering by owner
+* When listing images on AWS, filter only the ones by current account owner
+* Retrieve AWS instance types from a public service to include latest values
+* Instance state uses ``DELETED`` state instead of ``TERMINATED``
+* Return VM type RAM in GB
+* Add implementation for ``generate_url`` on OpenStack
+* General documentation updates
+
 0.3.3 - Aug 7, 2017. (sha 348e1e88935f61f53a83ed8d6a0e012a46621e25)
 0.3.3 - Aug 7, 2017. (sha 348e1e88935f61f53a83ed8d6a0e012a46621e25)
 -------
 -------
 
 
@@ -12,7 +40,7 @@
 0.3.1 - April 18, 2017. (sha f36a462e886d8444cb2818f6573677ecf0565315)
 0.3.1 - April 18, 2017. (sha f36a462e886d8444cb2818f6573677ecf0565315)
 -------
 -------
 
 
-* Patch for binary file handling in openstack
+* Patch for binary file handling in OpenStack
 
 
 0.3.0 - April 11, 2017. (sha 13539ccda9e4809082796574d18b1b9bb3f2c624)
 0.3.0 - April 11, 2017. (sha 13539ccda9e4809082796574d18b1b9bb3f2c624)
 -------
 -------
@@ -23,7 +51,7 @@
 * Added supports for accessing EC2 containers with restricted permissions.
 * Added supports for accessing EC2 containers with restricted permissions.
 * Removed exists() method from object store interface. Use get()==None check
 * Removed exists() method from object store interface. Use get()==None check
   instead.
   instead.
-* New method (img.min_disk) for geting size of machine image.
+* New method (img.min_disk) for getting size of machine image.
 * Test improvements (flake8 during build, more tests)
 * Test improvements (flake8 during build, more tests)
 * Misc bug fixes and improvements
 * Misc bug fixes and improvements
 * Changed library to beta state
 * Changed library to beta state
@@ -66,5 +94,5 @@
 * Support for AWS and OpenStack clouds
 * Support for AWS and OpenStack clouds
 * Basic usage docs and complete API docs
 * Basic usage docs and complete API docs
 * 95% test coverage
 * 95% test coverage
-* Support for AWS mock test provder (via
+* Support for AWS mock test provider (via
   `moto <https://github.com/spulec/moto>`_)
   `moto <https://github.com/spulec/moto>`_)

+ 10 - 7
docs/topics/release_process.rst

@@ -1,15 +1,18 @@
 Release Process
 Release Process
 ~~~~~~~~~~~~~~~
 ~~~~~~~~~~~~~~~
 
 
-1. Increment version number in cloudbridge/__init__.py as per semver rules.
+1. Increment version number in ``cloudbridge/__init__.py`` as per
+   `semver rules <https://semver.org/>_.
 
 
-2. Freeze all library dependencies in setup.py. The version numbers can be a range
-   with the upper limit being the latest known working version, and the lowest being
-   the last known working version. 
+2. Freeze all library dependencies in ``setup.py``. The version numbers can be
+   a range with the upper limit being the latest known working version, and the
+   lowest being the last known working version.
 
 
-3. Run all tox tests.
+3. Run all ``tox`` tests.
 
 
-4. Add release notes to CHANGELOG.rst. Also add last commit hash to changelog.
+4. Add release notes to ``CHANGELOG.rst``. Also add last commit hash to
+   changelog. List of commits can be obtained using
+   ``git shortlog <last release hash>..HEAD``
 
 
 5. Release to PyPi
 5. Release to PyPi
 
 
@@ -18,4 +21,4 @@ Release Process
    python setup.py sdist upload
    python setup.py sdist upload
    python setup.py bdist_wheel upload
    python setup.py bdist_wheel upload
 
 
-6. Tag release and make github release.
+6. Tag release and make GitHub release.