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: I93f6546ef9128bbf102595bd920f74a4959b7848
This commit is contained in:
Colleen Murphy 2015-06-26 17:15:16 -07:00
parent fd29cbdcee
commit 58bae2b85d
2 changed files with 19 additions and 15 deletions

19
CHANGELOG.md Normal file
View File

@ -0,0 +1,19 @@
##2015-06-17 - 5.1.0
###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Adding augeas insertion check
####Bugfixes
- MySQL: change default MySQL collate to utf8_general_ci
####Maintenance
- Update .gitreview file for project rename
- spec: pin rspec-puppet to 1.0.1
##2014-11-25 - 5.0.0
###Summary
Initial release for Juno.

View File

@ -11,7 +11,6 @@ openstacklib
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
--------
@ -325,17 +324,3 @@ Puppet Module :: OpenStack Version :: OpenStack Codename
4.0.0 -> 2014.1.0 -> Icehouse
5.0.0 -> 2014.2.0 -> Juno
```
Release Notes
-------------
**5.1.0**
* Update .gitreview file for project rename
* Adding augeas insertion check
* MySQL: change default MySQL collate to utf8_general_ci
* spec: pin rspec-puppet to 1.0.1
**5.0.0**
* This is the initial release of this module.