Added information about semantic versioning.
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/74725ef7 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/74725ef7 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/74725ef7 Branch: refs/heads/0.5.0 Commit: 74725ef7df156efaf9c458e9c301d17701d12c28 Parents: ae148d8 Author: David Toy <[email protected]> Authored: Mon Apr 22 10:29:35 2013 +0100 Committer: David Toy <[email protected]> Committed: Mon Apr 22 10:32:31 2013 +0100 ---------------------------------------------------------------------- docs/meta/versions.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/74725ef7/docs/meta/versions.md ---------------------------------------------------------------------- diff --git a/docs/meta/versions.md b/docs/meta/versions.md index 202b21a..67cd7d0 100644 --- a/docs/meta/versions.md +++ b/docs/meta/versions.md @@ -62,7 +62,7 @@ Other versions with documentation available are listed below. <!--- archive version --> -This is the archived documentation for Brooklyn v{{ site.brooklyn-version }} +This is the archived documentation for Brooklyn {{ site.brooklyn-version }} (generated {{ site.time }}, archived under {{ site.url }}). [View current documentation here.](/meta/versions.html) @@ -77,9 +77,7 @@ This is the archived documentation for Brooklyn v{{ site.brooklyn-version }} * **[0.5.0-rc.1](/v/0.5.0-rc.1)**: includes new JS GUI and REST API, rebind/persistence support, cleaner model and naming conventions, more entities (Apr 2013) -* **[v0.4.0](/v/0.4.0/)**: initial public GA release of Brooklyn to Maven Central, supporting wide range of entities and examples (Jan 2013) - - +* **[0.4.0](/v/0.4.0/)**: initial public GA release of Brooklyn to Maven Central, supporting wide range of entities and examples (Jan 2013) Note: To prevent accidentally referring to out-of-date information, @@ -87,3 +85,23 @@ a banner is displayed when accessing specific versions from the archive. You may <a href="#" onclick="set_user_versions_all();">disable all warnings</a> or <a href="#" onclick="clear_user_versions();">re-enable all warnings</a>. + + +### Versioning + +Brooklyn uses the [semantic versioning](http://semver.org/) guidelines. Releases will be numbered with the following format: + +`Brooklyn <major>.<minor>.<patch>` + +Breaking backward compatibility increments the `<major>` version. +New additions without breaking backward compatibility ups the `<minor>` version. +Bug fixes and misc changes bumps the `<patch>` version. +New major and minor releases zero the less significant counters. + +Additionally, Brooklyn's release process include Snapshots, Milestones and Release Candidates. + +A Snapshot (`-SNAPSHOT`) is the bleeding edge. This will not be stable. + +Milestone versions (`-Mn`) are frozen snapshots. Some code features may be stable, but the documentation and examples may not be complete. + +A Release Candidate (`-rc.n`) is a just-about-ready version.
