You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2016/01/30 04:38:34 UTC
[09/29] incubator-brooklyn git commit: update release process docs
for current repo structure
update release process docs for current repo structure
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/1d8b8e92
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/1d8b8e92
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/1d8b8e92
Branch: refs/heads/master
Commit: 1d8b8e920ff9a6b13d0c2f1c373ad4109c27558d
Parents: 2ee54b0
Author: John McCabe <jo...@johnmccabe.net>
Authored: Thu Jan 21 22:03:41 2016 +0000
Committer: John McCabe <jo...@johnmccabe.net>
Committed: Thu Jan 21 22:03:41 2016 +0000
----------------------------------------------------------------------
.../committers/release-process/make-release-artifacts.md | 6 +++---
.../developers/committers/release-process/publish.md | 10 +++++-----
.../committers/release-process/release-version.md | 8 ++++----
.../website/developers/committers/release-process/vote.md | 4 ++--
4 files changed, 14 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d8b8e92/brooklyn-docs/website/developers/committers/release-process/make-release-artifacts.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/website/developers/committers/release-process/make-release-artifacts.md b/brooklyn-docs/website/developers/committers/release-process/make-release-artifacts.md
index f72e0c3..81accb4 100644
--- a/brooklyn-docs/website/developers/committers/release-process/make-release-artifacts.md
+++ b/brooklyn-docs/website/developers/committers/release-process/make-release-artifacts.md
@@ -4,12 +4,12 @@ title: Make the release artifacts
navgroup: developers
---
-A release script is provided in `release/make-release-artifacts.sh`. This script will prepare all the release artifacts.
+A release script is provided in `brooklyn-dist/release/make-release-artifacts.sh`. This script will prepare all the release artifacts.
It is written to account for several Apache requirements, so you are strongly advised to use it rather than "rolling your own".
The release script will:
-- **Create source code and binary distribution artifacts** and place them in a temporary staging directory on your workstation, usually `releases/`.
+- **Create source code and binary distribution artifacts** and place them in a temporary staging directory on your workstation, usually `/tmp/`.
- **Create Maven artifacts and upload them to a staging repository** located on the Apache Nexus server.
The script has a single required parameter `-r` which is given the release candidate number - so `-r1` will create
@@ -25,7 +25,7 @@ mvn clean install -Papache-release
To run the script:
{% highlight bash %}
-./release/make-release-artifacts.sh -r$RC_NUMBER
+./brooklyn-dist/release/make-release-artifacts.sh -r$RC_NUMBER
{% endhighlight %}
It will show you the release information it has deduced, and ask yes-or-no if it can proceed. Please note that the
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d8b8e92/brooklyn-docs/website/developers/committers/release-process/publish.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/website/developers/committers/release-process/publish.md b/brooklyn-docs/website/developers/committers/release-process/publish.md
index b10d262..436dbc4 100644
--- a/brooklyn-docs/website/developers/committers/release-process/publish.md
+++ b/brooklyn-docs/website/developers/committers/release-process/publish.md
@@ -83,7 +83,7 @@ Update the website
------------------
*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).*
+[appropriate instructions](https://github.com/apache/incubator-brooklyn/tree/master/brooklyn-docs).*
### Publish documentation for the new release
@@ -105,7 +105,7 @@ cd -
Generate the permalink docs for the release:
{% highlight bash %}
-cd docs
+cd brooklyn-docs
./_build/build.sh guide-version --install
{% endhighlight %}
@@ -135,11 +135,11 @@ This should be done on the `master` branch:
git checkout master
{% endhighlight %}
-1. Edit the file `docs/_config.yml` - change `brooklyn-stable-version` to be the newly-release version, and
+1. Edit the file `brooklyn-docs/_config.yml` - change `brooklyn-stable-version` to be the newly-release version, and
`brooklyn-version` to be the current SNAPSHOT version on the master branch.
-2. Edit the file `docs/website/download/verify.md` to add links to the MD5/SHA1/SHA256 hashes and PGP signatures for the
+2. Edit the file `brooklyn-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.
+3. Edit the file `brooklyn-docs/website/meta/versions.md` to add the new version.
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"
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d8b8e92/brooklyn-docs/website/developers/committers/release-process/release-version.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/website/developers/committers/release-process/release-version.md b/brooklyn-docs/website/developers/committers/release-process/release-version.md
index eea6943..a22314b 100644
--- a/brooklyn-docs/website/developers/committers/release-process/release-version.md
+++ b/brooklyn-docs/website/developers/committers/release-process/release-version.md
@@ -32,10 +32,10 @@ git checkout -b $VERSION_NAME
git push -u apache $VERSION_NAME
{% endhighlight %}
-Now change the version numbers in this branch throughout the project using the script `release/change-version.sh` and commit it:
+Now change the version numbers in this branch throughout the project using the script `brooklyn-dist/release/change-version.sh` and commit it:
{% highlight bash %}
-./release/change-version.sh BROOKLYN $OLD_MASTER_VERSION $VERSION_NAME
+./brooklyn-dist/release/change-version.sh BROOKLYN $OLD_MASTER_VERSION $VERSION_NAME
git add .
# Now inspect the staged changes and ensure there are no surprises
git commit -m "Change version to $VERSION_NAME"
@@ -56,12 +56,12 @@ Example:
{% highlight bash %}
git checkout master
-./release/change-version.sh BROOKLYN $OLD_MASTER_VERSION $NEW_MASTER_VERSION
+./brooklyn-dist/release/change-version.sh BROOKLYN $OLD_MASTER_VERSION $NEW_MASTER_VERSION
git add .
# Now inspect the staged changes and ensure there are no surprises
{% endhighlight %}
-Open `docs/guide/misc/release-notes.md` and `docs/website/meta/versions.md` in your favourite editor and amend.
+Open `brooklyn-docs/guide/misc/release-notes.md` and `brooklyn-docs/website/meta/versions.md` in your favourite editor and amend.
For release notes this means bumping the reference to the previous version in the "Backwards Compatibility" section
and putting some placeholder text elsewhere.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d8b8e92/brooklyn-docs/website/developers/committers/release-process/vote.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/website/developers/committers/release-process/vote.md b/brooklyn-docs/website/developers/committers/release-process/vote.md
index d3f6930..e459bdd 100644
--- a/brooklyn-docs/website/developers/committers/release-process/vote.md
+++ b/brooklyn-docs/website/developers/committers/release-process/vote.md
@@ -7,10 +7,10 @@ navgroup: developers
Start the vote
--------------
-A script to generate the voting email can be found in `release/print-vote-email.sh`,
+A script to generate the voting email can be found in `brooklyn-dist/release/print-vote-email.sh`,
taking a single argument being the staging repo link. For example:
- release/print-vote-email.sh orgapachebrooklyn-1234 | pbcopy
+ brooklyn-dist/release/print-vote-email.sh orgapachebrooklyn-1234 | pbcopy
You should move the subject and put your name at the end, and simply eyeball the rest. This should be sent to **dev@brooklyn.incubator.apache.org**.