You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by m4...@apache.org on 2017/10/25 21:05:34 UTC
[49/50] [abbrv] brooklyn-docs git commit: Update README for release
documentation
Update README for release documentation
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/5af439f8
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/5af439f8
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/5af439f8
Branch: refs/heads/master
Commit: 5af439f8b073fd9542451906a128f086577f936a
Parents: 5f7dd64
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Authored: Wed Oct 25 14:27:44 2017 +0100
Committer: Thomas Bouron <th...@cloudsoftcorp.com>
Committed: Wed Oct 25 14:27:44 2017 +0100
----------------------------------------------------------------------
README.md | 18 ++++++++++--------
package.json | 2 +-
2 files changed, 11 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5af439f8/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 6d99a28..0f9fd8f 100644
--- a/README.md
+++ b/README.md
@@ -94,14 +94,16 @@ npm run javadoc
Preparing for a Release
-----------------------
-When doing a release and changing versions:
-
-* Before branching:
- * Change the `brooklyn_stable_version` variable in `_config.yml`
-* In the branch, with `change-version.sh` run (e.g. from `N.SNAPSHOT` to `N`)
- * Ensure the `start/release-notes.md` file is current
-* In master, with `change-version.sh` run (e.g. to `N+1-SNAPSHOT`)
- * Clear old stuff in the `start/release-notes.md` file
+When doing a release, there are couple of thing to do first:
+* create a release branch `<version>` then:
+ * update the following variables in `_config.yml`:
+ * `brooklyn_version` to `<version>` you are currently releasing
+ * `brooklyn_stable_version` to `<version>` you are currently releasing
+ * `path.doc` to `/v/<version>`
+ * run `change-version.sh <version>-SNAPSHOT <version>`
+* In `master` branch:
+ * run `change-version.sh <version>-SNAPSHOT <version+1>-SNAPSHOT`
+ * clear old stuff in the `start/release-notes.md` file
Publishing the docs and javadoc
--------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/5af439f8/package.json
----------------------------------------------------------------------
diff --git a/package.json b/package.json
index f1da4cd..1a56648 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "brooklyn-docs",
- "version": "0.13.0",
+ "version": "1.0.0",
"description": "Apache Brooklyn Documentation",
"main": "index.js",
"dependencies": {},