HowToRelease

This page is prepared for Hive committers. You need committer rights to create a new Hive release.

Hadoop Version Warning

This page assumes you are releasing from the master branch, and thus omits the use of Maven profiles to determine which version of Hadoop you are building against. If you are releasing from branch-1, you will need to add -Phadoop-2 to most of your Maven commands.

Preparation

Bulk update Jira to unassign from this release all issues that are open non-blockers and send follow-up notification to the developer list that this was done. There are two kinds of JIRAs that need to be taken care of:
1. Unresolved JIRAs with Target Version/s or Fix Version/s (legacy) set to the release in question.
2. Resolved/closed(!) JIRAs with Target Version/s, but not Fix Version/s set to the release in question (e.g. a JIRA targets 2.0.0 and 1.3.0, but was only committed to 2.0.0).
Run 'mvn clean apache-rat:check' and examine the generated report for any files, especially .java files which should all have Apache license headers. Note also, that each individual component will have a rat.txt inside it when you run this – be sure to check ql/target/rat.txt, for example. Add the license header to any file that is missing it (open a jira and submit a patch).
Update copyright date in NOTICE. If any components mentioned in them have updated versions, you would need to update the copyright dates for those. (Thejas comment: It sounds like entries are needed in NOTICE only if the license requires such attribution. See http://www.apache.org/legal/src-headers.html#notice.)

Branching

Skip this section if this is NOT the first release in a series (i.e., release X.Y.0).

Notify developers on the #hive IRC channel and dev@hive mailing lists that you are about to branch a release.

Create a branch for the release series:

git checkout -b branch-X.Y origin/master
git push -u origin branch-X.Y

Increment the value of the version property in all pom.xml files. For example, if the current value is 0.7.0-SNAPSHOT, the new value should be 0.8.0-SNAPSHOT. Please note that the SNAPSHOT suffix is required in order to indicate that this is an unreleased development branch. This can be accomplished with a single command using Maven's Versions plugin as follows:
```
mvn versions:set -DnewVersion=X.Y.0-SNAPSHOT -DgenerateBackupPoms=false
```
Make changes to metastore upgrade scripts. See HIVE-6555 on how this was done for HIVE 0.13.
Verify that the build is working with changes.
Commit these changes to master with a comment "Preparing for X.Y+1.0 development".

Updating Release Branch

These operations take place in the release branch.

Check out the release branch with:

git clone https://git-wip-us.apache.org/repos/asf/hive.git/ <hive_src_dir>
cd <hive_src_dir>
git checkout branch-X.Y

Update the version property value in all pom.xml files. You should remove the SNAPSHOT suffix and set version equal to hive-X.Y.Z where Z is the point release number in this release series (0 for the first one, in which case this step is a no-op since you already did this above when creating the branch). Use Maven's Versions plugin to do this as follows:
```
mvn versions:set -DnewVersion=0.7.0 -DgenerateBackupPoms=false
```
Update the the value of the TRACKING_BRANCH field in the .reviewboardrc file to point to the origin/branch-X.Y.
Verify that the build is working with changes.
Commit these changes with a comment "Preparing for X.Y.Z development".
If not already done, merge desired patches from trunk into the branch and commit these changes. Avoid usage of "git merge" to avoid too many merge commits. Either request the committer who committed that patch in master to commit to this branch, or commit it yourself, or try doing a git cherry-pick for trivial patches. Specifics of this step can be laid down by the release manager.
You probably also want to commit a patch (on both trunk and branch) which updates README.txt to bring it up to date (at a minimum, search+replacing references to the version number). Also check NOTICE to see if anything needs to be updated for recent library dependency changes or additions.
1. Select all of the JIRAs for the current release that aren't FIXED and do bulk update to clear the 'Fixed Version' field.
2. Likewise, use JIRA's Release Notes link to generate content for the RELEASE_NOTES.txt file. Be sure to select 'Text' format. (It's OK to do this with a direct commit rather than a patch.)
3. Update the release notes in trunk with the release notes in branch.

Tag the release candidate (R is the release candidate number, and also starts from 0):

git tag -a release-X.Y.Z-rcR -m "Hive X.Y.Z-rcR release."
git push origin release-X.Y.Z-rcR

Building

Make sure your release notes have been updated for any new commits, and go through the previous steps if necessary.

Build the release (binary and source versions) after running unit tests. Manually create the md5 files. On a Mac use md5 in place of md5sum.

% mvn install -Pdist -DskipTests -Dmaven.javadoc.skip=true -DcreateChecksum=true

% cd packaging/target
% md5 apache-hive-X.Y.Z-bin.tar.gz > apache-hive-X.Y.Z-bin.tar.gz.md5
% md5 apache-hive-X.Y.Z-src.tar.gz > apache-hive-X.Y.Z-src.tar.gz.md5

Verify that the MD5 checksums are valid:

% md5sum -c apache-hive-X.Y.Z-bin.tar.gz.md5
apache-hive-X.Y.Z-bin.tar.gz: OK

% md5sum -c apache-hive-X.Y.Z-src.tar.gz.md5
apache-hive-X.Y.Z-src.tar.gz: OK

Check that release file looks ok -- e.g., install it and run examples from tutorial.
Setup your PGP keys for signing the release, if you don't have them already.
1. See http://www.apache.org/dev/release-signing.html, http://www.apache.org/dev/openpgp.html.

Sign the release (see Step-By-Step Guide to Mirroring Releases for more information).

% gpg --armor --output apache-hive-X.Y.Z-bin.tar.gz.asc --detach-sig apache-hive-X.Y.Z-bin.tar.gz
% gpg --armor --output apache-hive-X.Y.Z-src.tar.gz.asc --detach-sig apache-hive-X.Y.Z-src.tar.gz

Copy release files to a public place.

% ssh people.apache.org mkdir public_html/apache-hive-X.Y.Z-rc-0
% scp -p apache-hive-X.Y.Z*.tar.gz* people.apache.org:public_html/apache-hive-X.Y.Z-rc-0

Publish Maven artifacts to the Apache staging repository:

% mvn deploy -DskipTests -Papache-release -Dmaven.javadoc.skip=true

Login to the Apache Nexus server and "close" the staged repository. This makes the artifacts available at a temporary URL.

Voting

Call a release vote on dev at hive.apache.org.

From: you@apache.org
To: dev@hive.apache.org
Subject: [VOTE] Apache Hive X.Y.Z Release Candidate N

Apache Hive X.Y.Z Release Candidate N is available here:

http://people.apache.org/~you/hive-X.Y.Z-candidate-N

Maven artifacts are available here:

https://repository.apache.org/content/repositories/orgapachehive-121/

Source tag for RCN is at:
http://svn.apache.org/viewvc/hive/tags/release-X.Y.Z-RCN/

Voting will conclude in 72 hours.

Hive PMC Members: Please test and vote.

Thanks.

Verifying the Release Candidate

Verifying the PGP signature:

#get the hive committers keys file
wget http://www.apache.org/dist/hive/KEYS 
or 
wget https://people.apache.org/keys/group/hive.asc

gpg --import <keys file>
gpg --verify hive-X.Y.Z-bin.tar.gz.asc  hive-X.Y.Z-bin.tar.gz
gpg --verify hive-X.Y.Z.tar.gz.asc  hive-X.Y.Z.tar.gz

Verifying the md5 checksum:
See the step under Building.

Publishing

Once three PMC members have voted for a release, it may be published.

Tag the release and delete the release candidate tag:

git tag -s rel/release-X.Y.Z release-X.Y.Z-rcR -m "HiveX.Y.Z release."  # where -rcR was the last tagged release candidate that passed the vote
git push origin rel/release-X.Y.Z
git push origin :release-X.YZ.rcR

Follow instructions in http://www.apache.org/dev/release-publishing.html#distribution to push the new release artifacts to http://www.apache.org/dist/, making sure to create a new directory for the new release, and re-linking the stable link to the latest build. Note that you need PMC privileges to do this step – if you do not have such privileges, please ping a PMC member to do this for you.
Wait 24 hours for release to propagate to mirrors.
In your base hive source directory, generate javadocs as follows:
```
mvn clean install javadoc:javadoc javadoc:aggregate -DskipTests
```
After you run this, you should have javadocs present in your <hive_source_dir>/target/site/apidocs

Check out the javadocs svn repository as follows:

svn co https://svn.apache.org/repos/infra/websites/production/hive/content/javadocs

Copy the generated javadocs from the source repository to the javadocs repository, add and commit:
```
mkdir <hive_javadocs_repo_dir>/rX.Y.Z/
cd <hive_javadocs_repo_dir>
cp -r <hive_source_dir>/target/site/apidocs ./rX.Y.Z/api
svn add rX.Y.Z
svn commit
```
If this is a bugfix release, svn rm the obsoleted version. (For eg., when committing javadocs for r0.13.1, r0.13.0 would have been removed)

Prepare to edit the website.

svn co https://svn.apache.org/repos/asf/hive/cms/trunk

Edit files content/downloads.mdtext and javadoc.mdtext to appropriately add entries for the new release in the appropriate location. For example, for 1.2.0, the entries made were as follows:

./content/downloads.mdtext:### 18 May 2015 : release 1.2.0 available
./content/downloads.mdtext:You can look at the complete [JIRA change log for this release][HIVE_1_2_0_CL].
./content/downloads.mdtext:[HIVE_1_2_0_CL]: https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12329345&styleName=Text&projectId=12310843
./content/javadoc.mdtext:  * [Hive 1.2.0 Javadocs][r1.2.0]
./content/javadoc.mdtext:[r1.2.0]: /javadocs/r1.2.0/api/index.html

As you can see, you will need a release note link for this release as created previously for this section.

Go to https://hive.staging.apache.org/hive/ , get the hive working copy, force a new copy if you don't see your changes yet, and then ask it to publish the new copy. That should update the downloads and javadocs page as per the changes you made to downloads.mdtext, javadoc.mdtext earlier, and also make available the new javadocs. If you don't see it yet, you may have to wait 24 hours - it should be there by then.
Update JIRA
1. Ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
2. Release the version. Visit the "Administer Project" page, then the "Manage versions" page. You need to have the "Admin" role in Hive's Jira for this step and the next.
3. Close issues resolved in the release. Disable mail notifications for this bulk change.
Login to the Apache Nexus server and mark the release candidate artifacts as released.

Send a release announcement to Hive user and dev lists as well as the Apache announce list. This email should be sent from your Apache email address:

From: you@apache.org
To: user@hive.apache.org, dev@hive.apache.org, announce@apache.org
Subject: [ANNOUNCE] Apache Hive X.Y.Z Released

The Apache Hive team is proud to announce the release of Apache Hive
version X.Y.Z.

The Apache Hive (TM) data warehouse software facilitates querying and
managing large datasets residing in distributed storage. Built on top
of Apache Hadoop (TM), it provides, among others:

* Tools to enable easy data extract/transform/load (ETL)

* A mechanism to impose structure on a variety of data formats

* Access to files stored either directly in Apache HDFS (TM) or in other
  data storage systems such as Apache HBase (TM)

* Query execution via Apache Hadoop MapReduce and Apache Tez frameworks.

For Hive release details and downloads, please visit:
https://hive.apache.org/downloads.html

Hive X.Y.Z Release Notes are available here: [UPDATE THIS LINK]
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310843&version=12316178 

We would like to thank the many contributors who made this release
possible.

Regards,

The Apache Hive Team

Preparing Branch for Future Maintenance Release

After the release has been completed, prepare the branch for the next development cycle.