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: Ic8be387f8b3d7dac0dd57b2b36b4a0d07696f55b
This commit is contained in:
Colleen Murphy 2015-06-26 11:29:22 -07:00
parent 4d18c07eed
commit d6369ecccf
2 changed files with 127 additions and 75 deletions

127
CHANGELOG.md Normal file
View File

@ -0,0 +1,127 @@
##2015-06-17 - 5.1.0
###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Add support for configuring coordination/backend_url
- Implement Ceilometer-API as a WSGI process support
- Switch to TLSv1
####Bugfixes
- crontab: ensure the script is run with shell
- Change default MySQL collate to utf8_general_ci
####Maintenance
- Pin puppetlabs-concat to 1.2.1 in fixtures
- Update .gitreview file for project rename
- spec: updates for rspec-puppet 2.x and rspec 3.x
##2014-11-20 - 5.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Migrate the mysql backend to use openstacklib::db::mysql, adding dependency
on puppet-openstacklib
- Bumped stdlib dependency to >=4.0.0
- Removed deprecation notices for sectionless ceilometer_config types for Juno
release
####Features
- Added ability to hide secrets from puppet logs
- Add package_ensure parameters to various classes to control package
installation
- Add ceilometer::policy to control policy.json
- Update validate_re expressions for Puppet 3.7
- 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 parameters to control whether to configure keystone users
- Add the ability to override the keystone service name in
ceilometer::keystone::auth
deprecated the mysql_module parameter
####Bugfixes
- Fix ceilometer-notification package name for RHEL
##2014-10-16 - 4.2.0
###Summary
This is a feature and bugfix release in the Icehouse series.
####Features
- Add new class for extended logging options
####Bugfixes
- Fix dependency on nova-common package
- Fix ssl parameter requirements for kombu and rabbit
- Fix mysql_grant call
- Fix ceilometer-collecter service relationships when service is disabled
##2014-06-19 - 4.1.0
###Summary
This is a feature and bigfix release in the Icehouse series.
####Features
- Add RabbitMQ SSL Support
####Bugfixes
- Fix dependency cycle bug
- Fix agent_notification_service_name
- Change default mysql charset to UTF8
####Maintenance
- Pin major gems
##2014-01-05 - 4.0.0
###Summary
This is a major release for OpenStack Icehouse but contains no API-breaking
changes.
####Backwards-incompatible changes
None
####Features
- Add ability to override notification topics
- Implement notification agent service
- Add support for puppetlabs-mysql 2.2 and greater
- Introduce ceilometer::config to handle additional custom options
####Bugfixes
- Fix region name configuration
- Fix ensure packages bug
##2014-03-26 - 3.1.1
###Summary
This is a bugfix release in the Havana series.
####Bugfixes
- Remove enforcement of glance_control_exchange
- Fix user reference in db.pp
- Allow db fields configuration without need for dbsync for better replicaset
support
- Fix alarm package parameters Debian/Ubuntu
##2014-02-14 - 3.1.0
###Summary
This is a feature and bugfix release in the Havana series.
####Features
- Remove log_dir from params and make logs configurable in init
####Bugfixes
- Fix package ceilometer-alarm type error on Debian
- Remove glance_notifications from notification_topic
- Don't match commented [DEFAULT] section
##2014-01-17 - 3.0.0
###Summary
- Initial release of the puppet-ceilometer module

View File

@ -12,7 +12,6 @@ Ceilometer
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
--------
@ -81,80 +80,6 @@ Contributors
This is the ceilometer module.
Release Notes
-------------
** 5.1.0 **
* Add support for configuring coordination/backend_url
* crontab: ensure the script is run with shell
* Implement Ceilometer-API as a WSGI process support
* Switch to TLSv1
* Pin puppetlabs-concat to 1.2.1 in fixtures
* Change default MySQL collate to utf8_general_ci
* Update .gitreview file for project rename
* spec: updates for rspec-puppet 2.x and rspec 3.x
** 5.0.0 **
* Stable Juno release
* Added package_ensure parameters to various classes to control package installation
* Added ceilometer::policy to control policy.json
* Updated validate_re expressions for Puppet 3.7
* Bumped stdlib dependency to >=4.0.0
* 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 parameters to control whether to configure keystone users
* Added the ability to override the keystone service name in ceilometer::keystone::auth
* Migrated the ceilometer::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
* Fixed ceilometer-notification package name for RHEL
* Removed deprecation notices for sectionless ceilometer_config types for Juno release
* Added ability to hide secrets from puppet logs
** 4.2.0 **
* Fixed dependency on nova-common package
* Added new class for extended logging options
* Fixed ssl parameter requirements for kombu and rabbit
* Fixed mysql_grant call
* Fixed ceilometer-collecter service relationships when service is disabled
** 4.1.0 **
* Added RabbitMQ SSL Support.
* Fixed dependency cycle bug.
* Fixed agent_notification_service_name.
* Changed default mysql charset to UTF8.
* Pinned major gems.
** 4.0.0 **
* Stable Icehouse release.
* Added ability to override notification topics.
* Implemented notification agent service.
* Fixed region name configuration.
* Fixed ensure packages bug.
* Added support for puppetlabs-mysql 2.2 and greater.
* Introduced ceilometer::config to handle additional custom options.
** 3.1.1 **
* Removed enforcement of glance_control_exchange.
* Fixed user reference in db.pp.
* Allow db fields configuration without need for dbsync for better replicaset support.
* Fixed alarm package parameters Debian/Ubuntu.
** 3.1.0 **
* Fixed package ceilometer-alarm type error on Debian.
* Remove log_dir from params and make logs configurable in init.
* Removed glance_notifications from notification_topic.
* Don't match commented [DEFAULT] section.
** 3.0.0 **
* Initial release of the puppet-ceilometer module.
License
--------