Repository: samza Updated Branches: refs/heads/master c7c030af7 -> 83ed46616
SAMZA-725: Fix the RELEASE.md to add more complete docs Project: http://git-wip-us.apache.org/repos/asf/samza/repo Commit: http://git-wip-us.apache.org/repos/asf/samza/commit/83ed4661 Tree: http://git-wip-us.apache.org/repos/asf/samza/tree/83ed4661 Diff: http://git-wip-us.apache.org/repos/asf/samza/diff/83ed4661 Branch: refs/heads/master Commit: 83ed466166b66fbe6869b0434e5b34093806fe38 Parents: c7c030a Author: Yi Pan <[email protected]> Authored: Tue Sep 1 15:32:24 2015 -0700 Committer: Yi Pan (Data Infrastructure) <[email protected]> Committed: Tue Sep 1 15:32:24 2015 -0700 ---------------------------------------------------------------------- RELEASE.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/samza/blob/83ed4661/RELEASE.md ---------------------------------------------------------------------- diff --git a/RELEASE.md b/RELEASE.md index f218bd4..72a56ea 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,15 +1,31 @@ -Validate that all Samza source files have proper license information in their header. +# Samza Release Procedure - ./gradlew check +Releasing Samza involves the following steps: + + # Send a [DISCUSS] to [email protected]. [Example](http://mail-archives.apache.org/mod_mbox/samza-dev/201503.mbox/%3CCABYbY7dsYAQo4_6qBvmUSOF37%2BUfsHRQ3dKOJV1qHJUTetKdAA%40mail.gmail.com%3E) + # Create the Release Candidate + # Send a [VOTE] to [email protected]. [Example](http://mail-archives.apache.org/mod_mbox/samza-dev/201503.mbox/%3CCAOErhNQsehZ8iEXsP5saKgr9qjD%3DART7-2OCWJcCbXJko9FV4A%40mail.gmail.com%3E) + # 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/) -Auto-generate all missing headers in files: +The following sections will be focusing on creating the release candidate, publish the source tarball, and publish website documents. - ./gradlew licenseFormatMain +## Steps to release Samza binary artifacts + +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 + +Validate that all Samza source files have proper license information in their header. + + ./gradlew check To release to a local Maven repository: ./gradlew clean publishToMavenLocal - ./gradlew -PscalaVersion=2.10 clean publishToMavenLocal To build a tarball suitable for an ASF source release (and its accompanying MD5 file): @@ -34,6 +50,10 @@ Make a signed git tag for the release candidate: git tag -s release-$VERSION-rc0 -m "Apache Samza $VERSION release candidate 0" +Push the release tag to remote repository: + + git push origin release-$VERSION-rc0 + Edit `$HOME/.gradle/gradle.properties` and add your GPG key information: signing.keyId=01234567 # Your GPG key ID, as 8 hex digits @@ -54,10 +74,36 @@ Build binary artifacts and upload them to the staging repository: # If it's built with Java 8, the classes won't be readable by Java 7. export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home ./gradlew clean uploadArchives - ./gradlew -PscalaVersion=2.10 clean uploadArchives Go to [repository web interface](https://repository.apache.org/), log in with Apache LDAP credentials, go to "Staging Repositories", select the org.apache.samza repository just created, and close it. This may take a minute or so. When it finishes, the UI shows a staging repository URL. This can be used in a project that depends on Samza, to test the release candidate. + +## Steps to Upload Source Tarball to Apache SVN + +Check out the following Apache dist SVN to local: + + svn checkout https://dist.apache.org/repos/dist/release/samza samza-dist + +Create the new version's sub-directory and add the source tarball, MD5, and asc files from the +previous step to the new directory: + + cd samza-dist + mkdir $VERSION + cp ${SAMZA_SRC_ROOT}/build/distribution/source/apache-samza-$VERSION-src.tgz $VERSION + cp ${SAMZA_SRC_ROOT}/build/distribution/source/apache-samza-$VERSION-src.tgz.MD5 $VERSION + cp ${SAMZA_SRC_ROOT}/build/distribution/source/apache-samza-$VERSION-src.tgz.asc $VERSION + svn add $VERSION + +Commit to Apache release SVN + + svn ci -m "Releasing Apache Samza $VERSION Source Tarballs" + +Check the download link [here|http://mirror.tcpdiag.net/apache/samza/] to make sure that the mirror +site has picked up the new release. + +## Steps to Update Public Document + +Please refer to docs/README.md, specifically "Release-new-version Website Checklist" section.
