Update version for 0.11.0 release
[samza.git] / RELEASE.md
1 # Samza Release Procedure
2
3 Releasing Samza involves the following steps:
4
5 * Send a [DISCUSS] to dev@samza.apache.org. [Example](http://mail-archives.apache.org/mod_mbox/samza-dev/201503.mbox/%3CCABYbY7dsYAQo4_6qBvmUSOF37%2BUfsHRQ3dKOJV1qHJUTetKdAA%40mail.gmail.com%3E)
6 * Create the Release Candidate
7 * Send a [VOTE] to dev@samza.apache.org. [Example](http://mail-archives.apache.org/mod_mbox/samza-dev/201503.mbox/%3CCAOErhNQsehZ8iEXsP5saKgr9qjD%3DART7-2OCWJcCbXJko9FV4A%40mail.gmail.com%3E)
8 * 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)
9 * Publish source tarball to Apache SVN
10 * Publish website documents for new release
11 * 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.)
12
13 The following sections will be focusing on creating the release candidate, publish the source tarball, and publish website documents.
14
15 ## Steps to release Samza binary artifacts
16
17 Before you start, here are a few prerequisite steps that would be useful later:
18
19    * Make sure you have your GPG key generated and added to KEYS file. GPG tools: https://gpgtools.org/
20    * Setup your personal website on Apache: http://www.apache.org/dev/new-committers-guide.html
21    * Setup access to author the apache blog: http://www.apache.org/dev/project-blogs#grantrights
22
23 And before you proceed, do the following steps:
24
25    * create a branch $VERSION from the latest master branch
26    * update the gradle.property s.t. the following property is $VERSION w/o the suffix '-SNAPSHOT':
27       version=$VERSION
28
29 Validate that all Samza source files have proper license information in their header.
30
31     ./gradlew check
32
33 To release to a local Maven repository:
34
35     ./gradlew clean publishToMavenLocal
36
37 To build a tarball suitable for an ASF source release (and its accompanying MD5 file):
38
39 First, clean any non-checked-in files from git (this removes all such files without prompting):
40
41     git clean -fdx
42
43 Alternatively, you can make a fresh clone of the repository to a separate directory:
44
45     git clone http://git-wip-us.apache.org/repos/asf/samza.git samza-release
46     cd samza-release
47
48 Then build the tarball:
49
50     ./gradlew clean sourceRelease
51
52 Then sign it:
53
54     gpg --sign --armor --detach-sig build/distribution/source/apache-samza-*.tgz
55
56 Make a signed git tag for the release candidate:
57
58     git tag -s release-$VERSION-rc0 -m "Apache Samza $VERSION release candidate 0"
59
60 Push the release tag to remote repository:
61
62     git push origin release-$VERSION-rc0
63
64 Edit `$HOME/.gradle/gradle.properties` and add your GPG key information:
65
66     signing.keyId=01234567                          # Your GPG key ID, as 8 hex digits
67     signing.secretKeyRingFile=/path/to/secring.gpg  # Normally in $HOME/.gnupg/secring.gpg
68     signing.password=YourSuperSecretPassphrase      # Plaintext passphrase to decrypt key
69     nexusUsername=yourname                          # Your username on Apache's LDAP
70     nexusPassword=password                          # Your password on Apache's LDAP
71
72 Putting your passwords there in plaintext is unfortunately unavoidable. The
73 [nexus plugin](https://github.com/bmuschko/gradle-nexus-plugin) supports asking
74 for them interactively, but unfortunately there's a
75 [Gradle issue](http://issues.gradle.org/browse/GRADLE-2357) which prevents us
76 from reading keyboard input (because we need `org.gradle.jvmargs` set).
77
78 Build binary artifacts and upload them to the staging repository:
79
80     # Set this to the oldest JDK which we are currently supporting for Samza.
81     # If it's built with Java 8, the classes won't be readable by Java 7.
82     export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home
83     ./gradlew clean uploadArchives
84
85 Go to [repository web interface](https://repository.apache.org/), log in with
86 Apache LDAP credentials, go to "Staging Repositories", select the org.apache.samza
87 repository just created, and close it. This may take a minute or so. When it
88 finishes, the UI shows a staging repository URL. This can be used in a project
89 that depends on Samza, to test the release candidate.
90
91 If the VOTE has successfully passed on the release candidate, you can log in to the 
92 [repository web interface](https://repository.apache.org) (same as above) and "release" 
93 the org.apache.samza repository listed under "Staging Repositories".
94
95 ## Steps to Upload Source Tarball to Apache SVN
96
97 Check out the following Apache dist SVN to local:
98
99    svn checkout https://dist.apache.org/repos/dist/release/samza samza-dist
100
101 Create the new version's sub-directory and add the source tarball, MD5, and asc files from the 
102 previous step to the new directory:
103
104    cd samza-dist
105    mkdir $VERSION
106    cp ${SAMZA_SRC_ROOT}/build/distribution/source/apache-samza-$VERSION-src.tgz $VERSION
107    cp ${SAMZA_SRC_ROOT}/build/distribution/source/apache-samza-$VERSION-src.tgz.MD5 $VERSION
108    cp ${SAMZA_SRC_ROOT}/build/distribution/source/apache-samza-$VERSION-src.tgz.asc $VERSION
109    svn add $VERSION
110
111 Commit to Apache release SVN
112
113    svn ci -m "Releasing Apache Samza $VERSION Source Tarballs"
114
115 Check the download link [here](http://www-us.apache.org/dist/samza/) to make sure that the mirror
116 site has picked up the new release. The third-party mirrors may take upto 24 hours to pick-up the release. 
117 In order to ensure that the release is available in public mirrors, wait for the release jars 
118 to show up in [maven central](http://search.maven.org/#search%7Cga%7C1%7Csamza). A full list of mirrors can be found [here](http://www.apache.org/dyn/closer.cgi).
119 Do not publish the website or any public document until the release jars are available for download.
120
121 ## Steps to Update Public Document
122
123 Please refer to docs/README.md, specifically "Release-new-version Website Checklist" section.