Split release notes into a CHANGELOG.md file

This patch splits out release notes into a separate dedicated file for
consistency with the puppetlabs puppet modules. Additionally, this
patch improves the release notes by:

- Fixing the tense to be consistent with commit message standards ("Add
  new feature" instead of "Added new feature" or "Adds new feature")
- Breaking up changes into categories to make it easier for operators
  to know what happened in the change: backwards-incompatible changes,
  features, bugfixes, and maintenance commits
- Linewrapping to 80 chars
- Adding release dates, formatted according to ISO-8601

Change-Id: I44f3e7bc16fa85dcdf6eab90f26fa6ad94c6e4fd
This commit is contained in:
Colleen Murphy 2015-06-26 17:48:59 -07:00
parent 9edd4fce3c
commit c4ca308c26
2 changed files with 144 additions and 96 deletions

144
CHANGELOG.md Normal file
View File

@ -0,0 +1,144 @@
##2015-06-17 - 5.1.0
###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Add seed parameter to ringbuilder::rebalance
- Allow setting reseller_prefix for keystone filter
- Add node_timeout parameter for proxy-server.conf
- Provide a mean to change the default rsync chmod
- Add manage_service feature
####Bugfixes
- Fix concat file mode
- Handle both string and array for memcache param
- read_affinity requires affinity sorting_method
- Remove unused fragment_title variable
- Fix ipv6 support
- Add base `swift` class name to call
- Swift proxy won't start if using proxy:ceilometer
- Correct proxy::authtoken docs
- Notify services if swift.conf is modified
- Use keystonemiddleware instead of client
####Maintenance
- Update .gitreview file for project rename
- mount.pp: fix lint issue
- doc spelling corrections
- Pin puppetlabs-concat to 1.2.1 in fixtures
- Update ssh module version
- Pin fixtures for stables branches
- Remove non-ASCII characters from puppet doc
- Fix spec tests in stable/juno branch
##2014-11-22 - 5.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Update s3token.conf template for Juno
- Bump stdlib dependency to >=4.0.0
####Features
- Add parameter log_name to swift::proxy and swift::storage::server
##2014-06-20 - 4.1.0
###Summary
This is a feature and bugfix release in the Icehouse series.
####Features
- Add swift-ring-builder multi-region support
- Add swift::proxy::crossdomain class
- Add support for RHEL 7
####Bugfixes
- Fix Swift quota filter names
- Fix config dependency bugs
- Fix resource conflict when ringserver and storage are on same node
- Fix selinux bugs
####Maintenance
- Pin major gems
##2014-05-01 - 4.0.0
###Summary
This is a major release for OpenStack Icehouse but contains no API-breaking
changes.
####Features
- Add support for parameterizing endpoint prefix
- Add read_affinity, write_affinity support to proxy
- Add proxyserver gatekeeper middleware
- Add swift::proxy::slo class
- Add support for allow_versions in Swift containers
- Add support for middlewares with hyphens in name
####Bugfixes
- Fix spurious warning in pipeline check
- Fix test files
- Fix deprecation warnings in inline templates
####Maintenance
- Update swift::keystone::auth spec tests
##2014-02-04 - 3.0.0
###Summary
This is a major release for OpenStack Havana but contains no API-breaking
changes.
####Features
- Added bulk middleware support
- Added quota middleware support
- Allow configuration of admin and internal protocols for keystone endpoint
####Bugfixes
- Fix Puppet 3.x template variable deprecation warning
- Add swift operator roles to Keystone
- Default include_service_catalog to false for improved performance
- Fix auth_token configuration
- Fix filter name for puppetdb
##2013-10-07 - 2.2.0
###Summary
This is a feature and bugfix release in the Grizzly series.
####Features
- Improve proxy directory signing support
####Bugfixes
- Various lint, and deprecation fixes
##2013-08-07 - 2.1.0
###Summary
This is a feature and bugfix release in the Grizzly series.
####Features
- Management of swift-bench
- allow_versions flag for object versioning
- ini_setting based custom types for configs
- Configurable log for proxy-server
- Adds signing directory
####Bugfixes
- Puppet lint and warning fixes
##2013-06-24 - 2.0.0
###Summary
Initial release on StackForge.
####Features
- Upstream is now part of stackforge
- swift_ring_builder supports replicator
- Supports swift 1.8
- Further Red Hat support
####Bugfixes
- Various cleanups and bug fixes

View File

@ -13,7 +13,6 @@ swift
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
8. [Contributors - Those with commits](#contributors)
9. [Release Notes - Notes on the most recent updates to the module](#release-notes)
Overview
--------
@ -258,98 +257,3 @@ Contributors
------------
* https://github.com/stackforge/puppet-swift/graphs/contributors
Release Notes
-------------
**5.1.0**
* Update .gitreview file for project rename
* mount.pp: fix lint issue
* Fix concat file mode
* Handle both string and array for memcache param.
* read_affinity requires affinity sorting_method
* Remove unused fragment_title variable
* Fix ipv6 support
* doc spelling corrections
* Add base `swift` class name to call
* Swift proxy won't start if using proxy:ceilometer
* Add seed parameter to ringbuilder::rebalance.
* Correct proxy::authtoken docs
* Allow setting reseller_prefix for keystone filter
* Pin puppetlabs-concat to 1.2.1 in fixtures
* Update ssh module version
* Notify services if swift.conf is modified
* Add node_timeout parameter for proxy-server.conf
* Provide a mean to change the default rsync chmod
* Pin fixtures for stables branches
* Use keystonemiddleware instead of client
* Add manage_service feature
* Remove non-ASCII characters from puppet doc
* Fix spec tests in stable/juno branch
**5.0.0**
* Stable Juno release
* Updated s3token.conf template for Juno
* Added parameter log_name to swift::proxy and swift::storage::server
* Bumped stdlib dependency to >=4.0.0
**4.1.0**
* Added swift-ring-builder multi-region support.
* Added swift::proxy::crossdomain class.
* Added support for RHEL 7.
* Fixed Swift quota filter names.
* Fixed config dependency bugs.
* Fixed resource conflict when ringserver and storage are on same node.
* Fixed selinux bugs.
* Pinned major gems.
**4.0.0**
* Stable Icehouse release.
* Added support for parameterizing endpoint prefix.
* Added read_affinity, write_affinity support to proxy.
* Added proxyserver gatekeeper middleware.
* Added swift::proxy::slo class.
* Added support for allow_versions in Swift containers.
* Add support for middlewares with hyphens in name.
* Fixed spurious warning in pipeline check.
* Fixed test files.
* Fixed deprecation warnings in inline templates.
* Updated swift::keystone::auth spec tests.
**3.0.0**
* Major release for OpenStack Havana.
* Fixed Puppet 3.x template variable deprecation warning.
* Added swift operator roles to Keystone.
* Defaults include_service_catalog to false for improved performance.
* Fixed auth_token configuration.
* Fixed filter name for puppetdb.
* Added bulk middleware support.
* Added quota middleware support.
* Allow configuration of admin and internal protocols for keystone endpoint.
**2.2.0**
* Improved proxy directory signing support.
* Various lint, and deprecation fixes.
**2.1.0**
* Management of swift-bench
* allow_versions flag for object versioning
* ini_setting based custom types for configs
* Configurable log for proxy-server
* Adds signing directory
* Puppet lint and warning fixes
**2.0.0**
* Upstream is now part of stackforge.
* swift_ring_builder supports replicator.
* Supports swift 1.8
* Further Red Hat support.
* Various cleanups and bug fixes.