Skip to content
Permalink
Browse files
Update README for release documentation
  • Loading branch information
tbouron committed Oct 25, 2017
1 parent 5f7dd64 commit 5af439f8b073fd9542451906a128f086577f936a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
@@ -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
--------------------------------
@@ -1,6 +1,6 @@
{
"name": "brooklyn-docs",
"version": "0.13.0",
"version": "1.0.0",
"description": "Apache Brooklyn Documentation",
"main": "index.js",
"dependencies": {},

0 comments on commit 5af439f

Please sign in to comment.