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: Iad66450804aea5ccd7c7c3120c44face0f667f18
This commit is contained in:
Colleen Murphy 2015-06-26 14:12:44 -07:00
parent 3cf09a66e3
commit a27e85d41b
2 changed files with 155 additions and 89 deletions

155
CHANGELOG.md Normal file

@ -0,0 +1,155 @@
##2015-06-17 - 5.1.0
###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Add support for the configuration of OPENSTACK_CINDER_FEATURES
####Bugfixes
- Sort policy files in local_settings.py
####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-25 - 5.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Switch the default log level to INFO from DEBUG
####Features
- Use concat to manage local_settings.py
- Add parameters to configure policy files in horizon class
- Add parameter django_session_engine to horizon class
- Change cache_server_ip in horizon class to accept arrays
####Bugfixes
- Fix the default value of compress_offline parameter
- Fix Apache config file default
- Stop setting wsgi_socket_prefix since the apache module takes care of it
- Add workaround for puppet's handling of undef for setting the vhost bind
address
- Fix the default MSSQL port in security group rules
##2014-10-16 - 4.2.0
###Summary
This is a feature and bugfix release in the Icehouse series.
####Features
- Add parameters to configure ALLOWED_HOSTS in settings_local.y and
ServerAlias in apache, no longer requiring these values to be the fqdn
- Add support for secure cookies
####Bugfixes
- Fix removal of vhost conf file
##2014-06-19 - 4.1.0
###Summary
####Features
- Add option to set temporary upload directory for images
####Bugfixes
- Ensure ssl wsgi_process_group is the same as wsgi_daemon_process
####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 to pass extra parameters to vhost
- Add support to ensure online cache is present and can be refreshed
- Add support to configure OPENSTACK_HYPERVISOR_FEATURES settings,
AVAILABLE_REGIONS, OPENSTACK_NEUTRON_NETWORK
- Add support to disable configuration of Apache
####Bugfixes
- Fix log ownership and WSGIProcess* settings for Red Hat releases
- Fix overriding of policy files in local settings
- Fix SSL bugs
- Improve WSGI configuration
####Maintenance
##2014-03-26 - 3.1.0
###Summary
This is a feature release in the Havana series.
####Features
- Add option parameterize OPENSTACK_NEUTRON_NETWORK settings
##2014-02-14 - 3.0.1
###Summary
This is a bugfix release in the Havana series.
####Bugfixes
- Add COMPRESS_OFFLINE option to local_settings to fix broken Ubuntu
installation
####Maintenance
##2014-01-16 - 3.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Havana.
####Backwards-incompatible changes
- Update user and group for Debian family OSes
- Update policy files for RedHat family OSes
- Change keystone_default_role to _member_
####Features
- Enable SSL support with cert/key
- Introduce new parameters: keystone_url, help_url, endpoint type
####Bugfixes
- Improve default logging configuration
- Fix bug to set LOGOUT_URL properly
- Fix user/group regression for Debian
####Maintenance
##2013-10-07 - 2.2.0
###Summary
This is a bugfix release in the Grizzly series.
####Bugfixes
- Fixed apache 0.9.0 incompatability
####Maintenance
- Various lint fixes
##2013-08-07 - 2.1.0
###Summary
This is a bugfix release in the Grizzly series.
####Bugfixes
- Update local_settings.py
####Maintenance
- Pin Apache module version
- Various lint fixes
##2013-06-24 - 2.0.0
###Summary
Initial release on StackForge.
####Features
- httpd config now managed on every platform
- Provide option to enable Horizon's display of block device mount points

@ -12,7 +12,6 @@ horizon
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
--------
@ -95,91 +94,3 @@ Contributors
------------
* https://github.com/openstack/puppet-horizon/graphs/contributors
Release Notes
-------------
**5.1.0**
* spec: pin rspec-puppet to 1.0.1
* Sort policy files in local_settings.py
* Pin puppetlabs-concat to 1.2.1 in fixtures
* Add support for the configuration of OPENSTACK_CINDER_FEATURES
* Update .gitreview file for project rename
**5.0.0**
* Stable Juno release
* Fixed the default value of compress_offline parameter
* Always manages local_settings.py
* Added parameters to configure policy files in horizon class
* Fixed Apache config file default
* Added parameter django_session_engine to horizon class
* Stops setting wsgi_socket_prefix since the apache module takes care of it
* Adds workaround for puppet's handling of undef for setting the vhost bind address
* Changes cache_server_ip in horizon class to accept arrays
* Switched the default log level to INFO from DEBUG
* Fixed the default MSSQL port in security group rules
**4.2.0**
* Added parameters to configure ALLOWED_HOSTS in settings_local.y and
ServerAlias in apache, no longer requiring these values to be the fqdn
* Fixed removal of vhost conf file
* Added support for secure cookies
**4.1.0**
* Added option to set temporary upload directory for images.
* Ensure ssl wsgi_process_group is the same as wsgi_daemon_process.
* Pined major gems.
**4.0.0**
* Stable Icehouse release.
* Added support to pass extra parameters to vhost.
* Added support to ensure online cache is present and can be refreshed.
* Added support to configure OPENSTACK_HYPERVISOR_FEATURES settings, AVAILABLE_REGIONS, OPENSTACK_NEUTRON_NETWORK.
* Added support to disable configuration of Apache.
* Fixed log ownership and WSGIProcess* settings for Red Hat releases.
* Fixed overriding of policy files in local settings.
* Fixed SSL bugs.
* Improved WSGI configuration.
**3.1.0**
* Added option parameterize OPENSTACK_NEUTRON_NETWORK settings.
**3.0.1**
* Adds COMPRESS_OFFLINE option to local_settings to fix broken Ubuntu installation.
**3.0.0**
* Major release for OpenStack Havana.
* Updated user and group for Debian family OSes.
* Updated policy files for RedHat family OSes.
* Enabled SSL support with cert/key.
* Improved default logging configuration.
* Fixed bug to set LOGOUT_URL properly.
* Introduced new parameters: keystone_url, help_url, endpoint type.
* Fixed user/group regression for Debian.
* Changed keystone_default_role to _member_.
**2.2.0**
* Fixed apache 0.9.0 incompatability.
* Various lint fixes.
**2.1.0**
* Updated local_settings.py.
* Pinned Apache module version.
* Various lint fixes.
**2.0.0**
* Upstream is now part of stackforge.
* httpd config now managed on every platform.
* Provides option to enable Horizon's display of block device mount points.