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: I5e77f8ac0f678c9a3b12326dd02afae9659f572d
This commit is contained in:
Colleen Murphy 2015-06-26 13:32:44 -07:00
parent 827ce8b1dc
commit 6c8c78c555
2 changed files with 101 additions and 63 deletions

101
CHANGELOG.md Normal file
View File

@ -0,0 +1,101 @@
##2015-06-17 - 5.1.0
###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Switch to TLSv1
- Implement Keystone domain creation
- Run dbsync when engine is upgraded
- db: Added postgresql backend using openstacklib helper
- Add option to configure flavor in heat.conf
####Bugfixes
- Rework delegated roles
- Change default MySQL collate to utf8_general_ci
- Fix ipv6 support
####Maintenance
- spec: pin rspec-puppet to 1.0.1
- Pin puppetlabs-concat to 1.2.1 in fixtures
- Update .gitreview file for project rename
##2014-11-24 - 5.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Bump stdlib dependency to >=4.0.0
####Features
- Add heat::policy to control policy.json
- Deprecate the sql_connection parameter for database_connection parameter
- Add parameters to configure deferred authentication method in heat::engine in
accordance with new Juno defaults
- Add parameters to control whether to configure users
- Add manage_service parameters to various classes to control whether the
service was managed, as well as added enabled parameters where not already
present
- Add the ability to override the keystone service name in keystone::auth
- Migrate the heat::db::mysql class to use openstacklib::db::mysql and
deprecated the mysql_module parameter
##2014-10-16 - 4.2.0
###Summary
This is a feature and bugfix release in the Icehouse series.
####Backwards-incompatible changes
####Features
- Add ability to hide secret type parameters from logs
- Add class for extended logging options
####Bugfixes
- Fix database resource relationships
- Fix ssl parameter requirements when using kombu and rabbit
##2014-06-19 - 4.1.0
###Summary
This is a feature release in the Icehouse series.
####Features
- Added SSL endpoint support
##2014-05-05 - 4.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Icehouse.
####Backwards-incompatible changes
- Fix outdated DB connection parameter
####Features
- Add SSL parameter for RabbitMQ
- Add support for puppetlabs-mysql 2.2 and greater
- Add option to define RabbitMQ queues as durable
####Bugfixes
- Fix Keystone auth_uri parameter
##2014-03-26 - 3.1.0
###Summary
This is a feature and bugfix release in the Havana series.
####Features
- Allow log_dir to be set to false to disable file logging
- Add support for database idle timeout
####Bugfixes
- Fix postgresql connection string
- Align Keystone auth_uri with other OpenStack services
- Fix the EC2 auth token settings
- Fix rabbit_virtual_host configuration
##2014-01-23 - 3.0.0
###Summary
Initial release of the puppet-heat module.

View File

@ -12,7 +12,6 @@ puppet-heat
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
7. [Contributors - Those with commits](#contributors)
8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
Overview
--------
@ -77,68 +76,6 @@ Contributors
* https://github.com/stackforge/puppet-heat/graphs/contributors
Release Notes
-------------
**5.1.0**
* Switch to TLSv1
* spec: pin rspec-puppet to 1.0.1
* Implement Keystone domain creation
* Run dbsync when engine is upgraded
* db: Added postgresql backend using openstacklib helper
* Rework delegated roles
* Pin puppetlabs-concat to 1.2.1 in fixtures
* change default MySQL collate to utf8_general_ci
* added option to configure flavor in heat.conf
* Fix ipv6 support
* Update .gitreview file for project rename
**5.0.0**
* Stable Juno release
* Added heat::policy to control policy.json
* Deprecated the sql_connection parameter for database_connection parameter
* Adds parameters to configure deferred authentication method in heat::engine in accordance with new Juno defaults
* Bumped stdlib dependency to >=4.0.0
* Added parameters to control whether to configure users
* Added manage_service parameters to various classes to control whether the service was managed, as well as added enabled parameters where not already present
* Added the ability to override the keystone service name in keystone::auth
* Migrated the heat::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
**4.2.0**
* Added ability to hide secret type parameters from logs
* Fixed database resource relationships
* Added class for extended logging options
* Fixed ssl parameter requirements when using kombu and rabbit
**4.1.0**
* Added SSL endpoint support.
**4.0.0**
* Stable Icehouse release.
* Added SSL parameter for RabbitMQ.
* Added support for puppetlabs-mysql 2.2 and greater.
* Added option to define RabbitMQ queues as durable.
* Fixed outdated DB connection parameter.
* Fixed Keystone auth_uri parameter.
**3.1.0**
* Fixed postgresql connection string.
* Allow log_dir to be set to false to disable file logging.
* Added support for database idle timeout.
* Aligned Keystone auth_uri with other OpenStack services.
* Fixed the EC2 auth token settings.
* Fixed rabbit_virtual_host configuration.
**3.0.0**
* Initial release of the puppet-heat module.
License
-------