You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by al...@apache.org on 2015/09/16 14:14:33 UTC
[1/3] incubator-brooklyn git commit: Update release instructions
Repository: incubator-brooklyn
Updated Branches:
refs/heads/master 841db6a25 -> 0aed0a1e3
Update release instructions
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/1071b342
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/1071b342
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/1071b342
Branch: refs/heads/master
Commit: 1071b34296986be8a1854e541c6f553063faa232
Parents: 07ec193
Author: Aled Sage <al...@gmail.com>
Authored: Mon Sep 14 14:53:42 2015 +0100
Committer: Aled Sage <al...@gmail.com>
Committed: Wed Sep 16 13:12:03 2015 +0100
----------------------------------------------------------------------
docs/README.md | 3 ++
.../committers/release-process/fix-release.md | 3 ++
.../release-process/make-release-artifacts.md | 2 +-
.../committers/release-process/publish.md | 45 +++++++++++++++++---
4 files changed, 45 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1071b342/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index ade8824..5e2ebf3 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -235,6 +235,9 @@ copied to `${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}`:
# versioned guide, relative to /v/<version>/
_build/build.sh 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:
_build/serve-public-site.sh
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1071b342/docs/website/developers/committers/release-process/fix-release.md
----------------------------------------------------------------------
diff --git a/docs/website/developers/committers/release-process/fix-release.md b/docs/website/developers/committers/release-process/fix-release.md
index 63e1483..254d906 100644
--- a/docs/website/developers/committers/release-process/fix-release.md
+++ b/docs/website/developers/committers/release-process/fix-release.md
@@ -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.
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1071b342/docs/website/developers/committers/release-process/make-release-artifacts.md
----------------------------------------------------------------------
diff --git a/docs/website/developers/committers/release-process/make-release-artifacts.md b/docs/website/developers/committers/release-process/make-release-artifacts.md
index 26c7dbf..f72e0c3 100644
--- a/docs/website/developers/committers/release-process/make-release-artifacts.md
+++ b/docs/website/developers/committers/release-process/make-release-artifacts.md
@@ -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 %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1071b342/docs/website/developers/committers/release-process/publish.md
----------------------------------------------------------------------
diff --git a/docs/website/developers/committers/release-process/publish.md b/docs/website/developers/committers/release-process/publish.md
index 1d7746e..b10d262 100644
--- a/docs/website/developers/committers/release-process/publish.md
+++ b/docs/website/developers/committers/release-process/publish.md
@@ -49,6 +49,11 @@ for ext in -src.tar.gz -src.zip -bin.tar.gz -bin.zip; do
done
{% 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 cred
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.*
+*Instructions on uploading to the website are beyond the scope of these instructions. Refer to the
+[appropriate instructions](https://github.com/apache/incubator-brooklyn/tree/master/docs).*
### 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/build.sh guide-version
+./_build/build.sh 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/build.sh guide-latest
+./_build/build.sh 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/verify.md` to add links to the MD5/SHA1/SHA256 hashes and PGP signatures for the
new version.
3. Edit the file `docs/website/meta/versions.md` to add the new version.
-4. Build the updated site with `./_build/build.sh website-root` and upload to the website.
+4. Build the updated site with `./_build/build.sh 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).
+
[2/3] incubator-brooklyn git commit: Fix links in docs
Posted by al...@apache.org.
Fix links in docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/4ff0111a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/4ff0111a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/4ff0111a
Branch: refs/heads/master
Commit: 4ff0111aff7315ab3b0ab0a1676cfd722d5d8b75
Parents: 1071b34
Author: Aled Sage <al...@gmail.com>
Authored: Mon Sep 14 14:54:03 2015 +0100
Committer: Aled Sage <al...@gmail.com>
Committed: Wed Sep 16 13:12:04 2015 +0100
----------------------------------------------------------------------
docs/guide/java/entitlements.md | 2 +-
docs/guide/misc/index.md | 1 +
docs/guide/misc/migrate-to-0.8.0.md | 2 +-
docs/guide/yaml/winrm/index.md | 2 +-
4 files changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ff0111a/docs/guide/java/entitlements.md
----------------------------------------------------------------------
diff --git a/docs/guide/java/entitlements.md b/docs/guide/java/entitlements.md
index f4e13b8..59de4aa 100644
--- a/docs/guide/java/entitlements.md
+++ b/docs/guide/java/entitlements.md
@@ -38,5 +38,5 @@ which re-use the LDAP authorization support in Brooklyn,
allowing permissions objects to be declared in LDAP leveraging regular expressions.
For more information on this, ask on IRC or the mailing list,
and see
-{% include java_link.html class_name="EntitlementManager" package_path="org/apache/brooklyn/core/mgmt/entitlement" project_subpath="api" %}.
+{% include java_link.html class_name="EntitlementManager" package_path="org/apache/brooklyn/api/mgmt/entitlement" project_subpath="api" %}.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ff0111a/docs/guide/misc/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/misc/index.md b/docs/guide/misc/index.md
index 75d76a0..fab2222 100644
--- a/docs/guide/misc/index.md
+++ b/docs/guide/misc/index.md
@@ -6,6 +6,7 @@ children:
- { title: Javadoc, path: javadoc/ }
- download.md
- release-notes.md
+- migrate-to-0.8.0.md
- known-issues.md
- { path: ../dev/, title_in_menu: "Developer Guide" }
- { path: /website/documentation/, title_in_menu: "All Documentation", menu_customization: { force_inactive: true } }
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ff0111a/docs/guide/misc/migrate-to-0.8.0.md
----------------------------------------------------------------------
diff --git a/docs/guide/misc/migrate-to-0.8.0.md b/docs/guide/misc/migrate-to-0.8.0.md
index 9152359..f2b9770 100644
--- a/docs/guide/misc/migrate-to-0.8.0.md
+++ b/docs/guide/misc/migrate-to-0.8.0.md
@@ -29,4 +29,4 @@ $ for x in `find . -type file` ; do sed -E -i .bak -f /tmp/migrate.sed $x ; done
$ find . -name "*.bak" -delete
{% endhighlight %}
-If you encounter any issues, please [contact us](/website/community/).
+If you encounter any issues, please [contact us](/community/).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/4ff0111a/docs/guide/yaml/winrm/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/winrm/index.md b/docs/guide/yaml/winrm/index.md
index 58b5524..0f95bd9 100644
--- a/docs/guide/yaml/winrm/index.md
+++ b/docs/guide/yaml/winrm/index.md
@@ -112,7 +112,7 @@ The installation script - referred to as `/Users/richard/install7zip.ps1` in the
Start-Process "msiexec" -ArgumentList '/qn','/i',$Dl -RedirectStandardOutput ( [System.IO.Path]::Combine($Path, "stdout.txt") ) -RedirectStandardError ( [System.IO.Path]::Combine($Path, "stderr.txt") ) -Wait
This is only a very simple example. A core complex example can be found in the [Microsoft SQL Server blueprint in the
-Brooklyn source code]({{ brooklyn.url.git }}/software/database/src/main/resources/org/apache/brooklyn/entity/database/mssql).
+Brooklyn source code]({{ site.brooklyn.url.git }}/software/database/src/main/resources/org/apache/brooklyn/entity/database/mssql).
Known Limitations and Special Cases
[3/3] incubator-brooklyn git commit: This closes #892
Posted by al...@apache.org.
This closes #892
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/0aed0a1e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/0aed0a1e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/0aed0a1e
Branch: refs/heads/master
Commit: 0aed0a1e32080cafc41b4d8dc67cfdaa3622d244
Parents: 841db6a 4ff0111
Author: Aled Sage <al...@gmail.com>
Authored: Wed Sep 16 13:13:39 2015 +0100
Committer: Aled Sage <al...@gmail.com>
Committed: Wed Sep 16 13:13:39 2015 +0100
----------------------------------------------------------------------
docs/README.md | 3 ++
docs/guide/java/entitlements.md | 2 +-
docs/guide/misc/index.md | 1 +
docs/guide/misc/migrate-to-0.8.0.md | 2 +-
docs/guide/yaml/winrm/index.md | 2 +-
.../committers/release-process/fix-release.md | 3 ++
.../release-process/make-release-artifacts.md | 2 +-
.../committers/release-process/publish.md | 45 +++++++++++++++++---
8 files changed, 49 insertions(+), 11 deletions(-)
----------------------------------------------------------------------