brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [1/3] incubator-brooklyn git commit: Update release instructions
Date Wed, 16 Sep 2015 12:14:33 GMT
Repository: incubator-brooklyn
Updated Branches:
  refs/heads/master 841db6a25 -> 0aed0a1e3

Update release instructions


Branch: refs/heads/master
Commit: 1071b34296986be8a1854e541c6f553063faa232
Parents: 07ec193
Author: Aled Sage <>
Authored: Mon Sep 14 14:53:42 2015 +0100
Committer: Aled Sage <>
Committed: Wed Sep 16 13:12:03 2015 +0100

 docs/                                  |  3 ++
 .../committers/release-process/   |  3 ++
 .../release-process/   |  2 +-
 .../committers/release-process/       | 45 +++++++++++++++++---
 4 files changed, 45 insertions(+), 8 deletions(-)
diff --git a/docs/ b/docs/
index ade8824..5e2ebf3 100644
--- a/docs/
+++ b/docs/
@@ -235,6 +235,9 @@ copied to `${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}`:
     # versioned guide, relative to /v/<version>/
     _build/ guide-version --install
+(If HTML-Proofer find failures, then fix the links etc. Unfortunately, the javadoc build

+gives a lot of warnings. Fixing those is not part of this activity).
 You can then preview the public site of [localhost:4000](http://localhost:4000) with:
diff --git a/docs/website/developers/committers/release-process/ b/docs/website/developers/committers/release-process/
index 63e1483..254d906 100644
--- a/docs/website/developers/committers/release-process/
+++ b/docs/website/developers/committers/release-process/
@@ -6,5 +6,8 @@ navgroup: developers
 Make whatever changes are necessary on the release branch, supported by discussions on the
mailing list.
+Repeat the instructions to [make release artifacts](make-release-artifacts.html).
 Remember that after the release is done, you should cherry-pick the changes to a new feature
branch based on `master`
 and open a pull request, so that the next version will incorporate the bug fixes.
diff --git a/docs/website/developers/committers/release-process/
index 26c7dbf..f72e0c3 100644
--- a/docs/website/developers/committers/release-process/
+++ b/docs/website/developers/committers/release-process/
@@ -54,5 +54,5 @@ Make a signed tag for this release, and then push the tag:
 {% highlight bash %}
 git tag -s -m "Tag release ${VERSION_NAME} release candidate ${RC_NUMBER}" apache-brooklyn-${VERSION_NAME}-rc${RC_NUMBER}
-git push origin apache-brooklyn-${VERSION_NAME}-rc${RC_NUMBER}
+git push apache apache-brooklyn-${VERSION_NAME}-rc${RC_NUMBER}
 {% endhighlight %}
diff --git a/docs/website/developers/committers/release-process/ b/docs/website/developers/committers/release-process/
index 1d7746e..b10d262 100644
--- a/docs/website/developers/committers/release-process/
+++ b/docs/website/developers/committers/release-process/
@@ -49,6 +49,11 @@ for ext in -src.tar.gz -bin.tar.gz; do
 {% endhighlight %}
+(You may get warnings such as: `gpg: WARNING: This key is not certified with a trusted signature!`

+and `There is no indication that the signature belongs to the owner.` This happens if you
have not trusted
+the person's key. A key-signing party is a good way to extend this web of trust).
 Then, add them to Subversion and commit.
 {% highlight bash %}
@@ -69,12 +74,16 @@ link in the top right (the credentials are the same as your Git and Jenkins
 Repositories" page, and tick the repository with the name starting `orgapachebrooklyn`. Click
the **Release** button.
 Provide a description which includes the version, e.g. `Apache Brooklyn 0.7.0-incubating`.
+Note there is only one orgapachebrooklyn staging repository at a time; this will be the one
created for the release
+candidate with whatever name was used there (e.g. it might include "rc" in the name). If
you really want, you can 
+double-check under the "content" that brooklyn-dist has artifacts without rc in the name.
 Update the website
-*Instructions on uploading to the website are beyond the scope of these instructions. Refer
to the appropriate
+*Instructions on uploading to the website are beyond the scope of these instructions. Refer
to the 
+[appropriate instructions](*
 ### Publish documentation for the new release
@@ -85,11 +94,19 @@ git checkout ${VERSION_NAME}
 mvn clean install -DskipTests
 {% endhighlight %}
+Ensure the SVN repo is up-to-date (very painful otherwise!)
+{% highlight bash %}
+cd ${BROOKLYN_SITE_DIR-../incubator-brooklyn-site-public}
+svn up
+cd -
+{% endhighlight %}
 Generate the permalink docs for the release:
 {% highlight bash %}
 cd docs
-./_build/ guide-version
+./_build/ guide-version --install
 {% endhighlight %}
 Now publish _site/v/*${VERSION_NAME}* to the public website.
@@ -97,10 +114,18 @@ Now publish _site/v/*${VERSION_NAME}* to the public website.
 Update the "latest" docs to this release:
 {% highlight bash %}
-./_build/ guide-latest
+./_build/ guide-latest --install
+{% endhighlight %}
+Now publish _site/v/latest to the public website:
+{% highlight bash %}
+cd ${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}
+svn add * --force
+export DELETIONS=$( svn status | sed -e '/^!/!d' -e 's/^!//' )
+if [ ! -z "${DELETIONS}" ] ; then svn rm ${DELETIONS} ; fi
 {% endhighlight %}
-Now publish _site/v/latest to the public website.
 ### Update the main website to link to the new release
@@ -115,7 +140,9 @@ git checkout master
 2. Edit the file `docs/website/download/` to add links to the MD5/SHA1/SHA256 hashes
and PGP signatures for the
    new version.
 3. Edit the file `docs/website/meta/` to add the new version.
-4. Build the updated site with `./_build/ website-root` and upload to the website.
+4. Build the updated site with `./_build/ website-root --install`.
+5. Publish to the public website.
+6. Commit your changes to master, e.g. with a message like "Update latest docs to 0.8.0-incubating"
 Tag the release in git
@@ -125,5 +152,9 @@ Make a signed tag for this release, based on the tag for the release candidate,
 {% highlight bash %}
 git tag -s -m "Tag release ${VERSION_NAME}" apache-brooklyn-${VERSION_NAME} apache-brooklyn-${VERSION_NAME}-rc${RC_NUMBER}
-git push origin apache-brooklyn-${VERSION_NAME}
+git push apache apache-brooklyn-${VERSION_NAME}
 {% endhighlight %}
+Note the tag `apache-brooklyn-${VERSION_NAME}-rc${RC_NUMBER}` should have been created as
part of the
+RC creation - see [make-release-artifacts](make-release-artifacts.html).

View raw message