[Documentation] clarifying some of the release instructions (#1321)
diff --git a/RELEASE.md b/RELEASE.md
index 09d67ce..9b34f78 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -8,7 +8,9 @@
* Wait till the [VOTE] completes and send [RESULT][VOTE]. [Example](http://mail-archives.apache.org/mod_mbox/samza-dev/201412.mbox/%3CCADiKvVuAkgiR7-0VBYccez96xtfV6edavdy7xc%3Drg9GCftaEsg%40mail.gmail.com%3E)
* Publish source tarball to Apache SVN
* Publish website documents for new release
-* Write a blog post on [Apache Blog](https://blogs.apache.org/samza/) (Note: Apache blog editor is primitive. You have to provide HTML formatted document.)
+* Write a blog post on [Apache Blog](https://blogs.apache.org/samza/)
+* Update the Samza version of the master branch to the next version
+* Update [samza-hello-samza](https://github.com/apache/samza-hello-samza) to use the new Samza version
The following sections will be focusing on creating the release candidate, publish the source tarball, and publish website documents.
@@ -16,9 +18,10 @@
Before you start, here are a few prerequisite steps that would be useful later:
- * Make sure you have your GPG key generated and added to KEYS file. GPG tools: https://gpgtools.org/
- * Setup your personal website on Apache: http://www.apache.org/dev/new-committers-guide.html
- * Setup access to author the apache blog: http://www.apache.org/dev/project-blogs#grantrights
+ * You may find https://www.apache.org/dev/release-signing.html useful for providing some additional context regarding the release process.
+ * Make sure you have your GPG key generated/signed/published and added to KEYS file. GPG tools: https://gpgtools.org/
+ * Setup your personal website on Apache: https://www.apache.org/dev/new-committers-guide.html#personal-web-space
+ * Setup access to author the apache blog: https://infra.apache.org/pages/project-blog.html
And before you proceed, do the following steps:
@@ -63,6 +66,7 @@
```bash
git clone http://git-wip-us.apache.org/repos/asf/samza.git samza-release
cd samza-release
+ git checkout $VERSION
```
Then build the source and samza-tools tarballs:
@@ -74,25 +78,25 @@
Then sign them:
```bash
- gpg --sign --armor --detach-sig ./build/distribution/source/apache-samza-*.tgz
- gpg --sign --armor --detach-sig ./samza-tools/build/distributions/samza-tools-*.tgz
+ gpg --sign --armor --detach-sig ./build/distribution/source/apache-samza-$VERSION-src.tgz
+ gpg --sign --armor --detach-sig ./samza-tools/build/distributions/samza-tools_$SCALAVERSION-$VERSION.tgz
```
Create MD5 signatures:
```bash
- gpg --print-md MD5 ./build/distribution/source/apache-samza-*.tgz > ./build/distribution/source/apache-samza-*.tgz.md5
- gpg --print-md MD5 ./samza-tools/build/distributions/samza-tools-*.tgz > ./samza-tools/build/distributions/samza-tools-*.tgz.md5
+ gpg --print-md MD5 ./build/distribution/source/apache-samza-$VERSION-src.tgz > ./build/distribution/source/apache-samza-$VERSION-src.tgz.md5
+ gpg --print-md MD5 ./samza-tools/build/distributions/samza-tools_$SCALAVERSION-$VERSION.tgz > ./samza-tools/build/distributions/samza-tools_$SCALAVERSION-$VERSION.tgz.md5
```
Create SHA1 signatures:
```bash
- gpg --print-md SHA1 ./build/distribution/source/apache-samza-*.tgz > ./build/distribution/source/apache-samza-*.tgz.sha1
- gpg --print-md SHA1 ./samza-tools/build/distributions/samza-tools-*.tgz > ./samza-tools/build/distributions/samza-tools-*.tgz.sha1
+ gpg --print-md SHA1 ./build/distribution/source/apache-samza-$VERSION-src.tgz > ./build/distribution/source/apache-samza-$VERSION-src.tgz.sha1
+ gpg --print-md SHA1 ./samza-tools/build/distributions/samza-tools_$SCALAVERSION-$VERSION.tgz > ./samza-tools/build/distributions/samza-tools_$SCALAVERSION-$VERSION.tgz.sha1
```
-Upload the build artifacts to your Apache home directory:
+Upload the build artifacts to your Apache home directory (you can authorize your public SSH key through https://id.apache.org):
```bash
sftp <apache-username>@home.apache.org
@@ -100,7 +104,7 @@
mkdir samza-$VERSION-rc0
cd samza-$VERSION-rc0
put ./build/distribution/source/apache-samza-$VERSION-src.* .
- put ./samza-tools/build/distributions/samza-tools-$VERSION.* .
+ put ./samza-tools/build/distributions/samza-tools_$SCALAVERSION-$VERSION.* .
bye
```
@@ -160,6 +164,8 @@
## Steps to Upload Source Tarball to Apache SVN
+Note that only PMCs have permissions to commit to this repository.
+
Check out the following Apache dist SVN to local:
```bash
@@ -193,3 +199,24 @@
## Steps to Update Public Documentation
Please refer to docs/README.md, specifically "Release-new-version Website Checklist" section.
+
+## Write a blog post on the Apache blog site
+
+You can use the same content as the blog you wrote for the Samza site.
+
+Notes:
+* Apache blog editor is primitive. You have to provide HTML formatted document, but you should pretty much be able
+to use the HTML source generated for the Samza site.
+* Only PMCs have permissions to update https://blogs.apache.org/samza/. If you are not a PMC, then you can ask a PMC to
+update the blog or ask a PMC to add write permissions for you.
+
+## Update samza-hello-samza
+
+Make sure that the `master` branch of [samza-hello-samza](https://github.com/apache/samza-hello-samza) is synced with the
+`latest` branch.
+```bash
+ git merge latest
+```
+In the `master` branch, remove the `-SNAPSHOT` part of the Samza version in `gradle.properties` and `pom.xml`.
+
+In the `latest` branch, update the Samza version in `gradle.properties` and `pom.xml` to be the next version of Samza.
diff --git a/docs/README.md b/docs/README.md
index 5f091e6..d352e44 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -22,7 +22,7 @@
2. Install [Bundler](http://bundler.io/) by running `sudo gem install bundler`
3. To install Jekyll and its dependencies, change to the `docs` directory and run `bundle install`
-To serve the website on [localhost:4000](http://localhost:4000/):
+To serve the website on [localhost:4000](http://localhost:4000/) (run from the `docs` directory):
bundle exec jekyll serve --watch --baseurl ""
@@ -41,7 +41,8 @@
_docs/local-site-test.sh
-The local-site-test.sh script must be run every time a change is made to versioned content locally in order to trigger a refresh with Jekyll.
+Run this script after starting the site server with the `serve` command above. Otherwise, you may see some errors when trying to view versioned content.
+In addition, the local-site-test.sh script must be run every time a change is made to versioned content locally in order to trigger a refresh with Jekyll.
Keep in mind that versioned content in older versions links to samza.apache.org, not the localhost:4000. This is because they are not updated by your branch and are using the values in SVN instead.
@@ -89,7 +90,9 @@
* update the download page (docs/startup/download/index.md) to use x.x.x release
by adding an entry to the Sources and Samza Tools sections to use the new x.x.x release
- * add a release page samza/docs/_releases/x.x.x.md
+ * add a release page samza/docs/_releases/x.x.x.md
+
+ * add a new entry for the new version in samza/docs/_menu/index.html
* update the version number in "tar -xvf ./target/hello-samza-y.y.y-dist.tar.gz -C deploy/samza" in each of the tutorials (and search for other uses of version x.x.x which may need to be replaced with y.y.y)
* docs/startup/hello-samza/versioned/index.md
