Preparing Spark Releases

This document covers the process for managing Spark releases.

Prerequisites for Managing A Release

Pre-prerequisites

Must have an Apache account
Make sure you can access your Apache web space. Try ssh-ing into <USER_NAME>@people.apache.org.
Set up password-less access by uploading your public key.

Create a GPG Key (https://www.apache.org/dev/release-signing)

# ---- Install GPG ----
# For Ubuntu, install through apt-get
$ sudo apt-get install gnupg
# For Mac OSX, install GPG Suite from http://gpgtools.org

# ---- Generate key ----
$ gpg --gen-key                   # Create new key, make sure it is RSA and 4096 bits (see https://www.apache.org/dev/openpgp.html#generate-key)
$ gpg --output <KEY_ID>.asc --export -a <KEY_ID>  # Generate public key file for distribution to Apache infrastructure

# ---- Distribute key ----
$ gpg --send-key <KEY_ID>         # Distribute public key to a key server, <KEY_ID> is the 8 HEX characters in the output of the previous command "pub  4096R/<KEY_ID> "
$ gpg --fingerprint               # Get key digest
# Open http://id.apache.org , login with Apache account and upload the key digest
$ scp <KEY_ID>.asc <USER_NAME>@people.apache.org:~/   # Copy generated <KEY_ID>.asc to Apache web space
# Create an FOAF file and add it via svn (see http://people.apache.org/foaf/ )
#   - should include key fingerprint
# Eventually key will show up on apache people page (e.g. https://people.apache.org/keys/committer/pwendell.asc )

Get Access to Apache Nexus for Publishing Artifacts

You have this iff you can log into repository.apache.org with Apache username/password
If you cannot get access, create an Apache infrastructure JIRA issue and request access, giving your Apache I.D.
Install LDAP credentials in your ~/.m2/settings.xml file as described here for publishing

Get "Push" Access to Apache Git Repository

git remote add apache https://git-wip-us.apache.org/repos/asf/spark.git

Preparing the Code for a Release

Ensure Spark is Ready for a Release

Check JIRA for remaining issues tied to the release
- Review and merge any blocking features
- Bump other remaining features to subsequent releases
Ensure Spark versions are correct in the codebase
- See this example commit
- The places to change are:
  - SBT build: Change version in file 'project/SparkBuild.scala'
  - Maven build: Change version in ALL the pom.xml files in repo. Note that the version should be SPARK-VERSION_SNAPSHOT and it will be changed to SPARK-VERSION automatically by Maven when cutting the release.
    - Exception: Change 'yarn/alpha/pom.xml' to SPARK-VERSION. Note that this is different from the main 'pom.xml' because the YARN alpha module does not get published as an artifact through Maven when cutting the release and so does not get version bumped from SPARK-VERSION_SNAPSHOT to SPARK-VERSION.
  - Spark REPLs
    - Scala REPL: Check inside 'repl/src/main/scala/org/apache/spark/repl/'
    - Python REPL: Check inside 'python/pyspark'
  - Docs: Change in file 'docs/_config.yml'
  - Spark EC2 scripts: Change mapping between Spark and Shark versions and the default Spark version in cluster

Check Out and Run Tests

$ git clone https://git-wip-us.apache.org/repos/asf/spark.git -b branch-0.9
$ cd spark
$ sbt/sbt assembly
$ export MAVEN_OPTS="-Xmx3g -XX:MaxPermSize=1g -XX:ReservedCodeCacheSize=1g"
$ mvn test

Check for Dead Links in the Docs

$ cd $SPARK_HOME/docs
$ jekyll serve --watch
$ sudo apt-get install linkchecker
$ linkchecker -r 2 http://localhost:4000 --no-status --no-warnings

Run License Audit Tool (not necessary for Spark 1.0)

Check whether all the source files have Apache headers. Note that Spark REPL files and some pyspark files will have other license headers (as they are not Apache licensed) and should be ignored.

$ java -jar /path/to/apache-rat-0.10.jar --dir . --exclude *.md > rat_results.txt
$ vi rat_results.txt
$ # Look for source files that seem to have missing headers
$ cat rat_results.txt  | grep "???" | grep -e \.scala$ -e \.java$ -e \.py$ -e \.sh$
$ # Add missing headers if necessary

Create new CHANGES.txt File

The new CHANGES.txt can be generated using this script.

Checkout the Spark release version in a Spark git repository.
Download the script to a location within the repo.
Updated the previous release tag, and other information in the script.

Set SPARK_HOME environment variable and run the script.

$ export SPARK_HOME="..."
$ python -u generate-changelist.py

Cutting a Release Candidate

Overview

Cutting a release candidate involves a two steps. First, we use the Maven release plug-in to create a release commit (a single commit where all of the version files have the correct number) and publish the code associated with that release to a staging repository in Maven. Second, we check out that release commit and package binary releases and documentation.

Setting up EC2 Instance (Recommended)

The process of cutting a release requires a number of tools to be locally installed (maven, jekyll, etc). Ubuntu users can install those tools via apt-get. However, it may be most convenient to use a EC2 instance based on the AMI ami-b897fe88 (available is US-West, has Scala 2.10.3 and SBT 0.13.1 installed). This has all the necessary tools installed. Mac users are especially recommended to use a EC2 instance instead of attempting to install all the necessary tools. If you want to prepare your own EC2 instance (different version of Scala, SBT, etc.), follow the steps given in the Miscellaneous section (see at the end of this document).
Consider using CPU-optimized instances, which may provide better bang for the buck.

Transfer your GPG keys from your home machine to the EC2 instance.

# == On home machine ==
gpg --list-keys  # Identify the KEY_ID of the key you generated
gpg --output pubkey.gpg --export <KEY_ID>
gpg --output ---export-secret-key <KEY_ID> | cat pubkey.gpg - | gpg --armor --output keys.asc --symmetric --cipher-algo AES256
# Copy keys.asc to EC2 instance
 
# == On EC2 machine ==
gpg --no-use-agent --output - keys.asc | gpg --import
rm keys.asc

Install your private key that allows you to have password-less access in Apache webspace.

Set git user name and email (these are going to appear as the committer in the release commits).

$ git config --global user.name "Tathagata Das"
$ git config --global user.email tathagata.das1565@gmail.com

Download appropriate version of Spark that has the right scripts related to the releases.
If you want to run Spark tests, then you will also have to install fortran library to run the MLLib test. Check out the error while running MLLib tests for instructions on installing the necessary libraries.
- TODO: The AMI should be updated with this installed.

Creating Release Candidates

Make sure Maven is configured with your Apache username and password. Your ~/.m2/settings.xml should have the following.

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>apache.snapshots.https</id>
<username>APACHE_USERNAME</username>
<password>PASSWORD</password>
</server>
<server>
<id>apache.releases.https</id>
<username>APACHE_USERNAME</username>
<password>PASSWORD</password>
</server>
</servers>
</settings>

The process of creating releases has been automated via this create release script.
- Configure the script by specifying the Apache username + password and the Apache GPG key passphrase. BE CAREFUL to not to accidentally check them in.
- This script can be run in any directory.
- Make sure you have password-less access to Apache webspace (people.apache.org) from the machine you are running the script on. Otherwise uploading of binary tarballs and docs will fail and you will have upload them manually.
- Read and understand the script fully before you execute it. It will cut a Maven release, build binary releases and documentation, then copy the binary artifacts to a staging location on people.apache.org.
- NOTE: You must use git 1.7.X for this or else you'll hit this horrible bug.
After script has completed, find the open staging repository in Apache Nexus to which the artifacts were uploaded to. Close the staging repository. Wait for the closing to succeed. Now all the staged artifacts are public!

Rolling Back Release Candidates

If a release candidate does not pass, it is necessary to roll back the commits which advanced Spark's versioning.

# Checkout the release branch from Apache repo
 
# Delete earlier tag. If you are using RC-based tags (v0.9.1-rc1) then skip this.
$ git tag -d v0.9.1
$ git push origin :v0.9.1

# Revert changes made by the Maven release plugin 
git revert HEAD --no-edit    # revert dev version commit
git revert HEAD~2 --no-edit  # revert release commit
git push apache HEAD:branch-0.9

Auditing a Staged Release Candidate

The process of auditing release has been automated via this release audit script.
- Find the staging repository in Apache Nexus to which the artifacts were uploaded to.
- Configure the script by specfiying the version number to audit, the key ID of the signing key, and the URL to staging repository.
- This script has to be run from the parent directory for the script.
- Make sure "sbt" is installed.
The release auditor will test example builds against the staged artifacts, verify signatures, and check for common mistakes made when cutting a release.

Calling a Release Vote

The release voting takes place on the Apache Spark developers list (the PMC is voting). Look at past vote threads to see how this goes. See the draft below.
- Attach the CHANGES.txt file in the e-mail.
- If possible, attach a draft of the release notes with the e-mail.
- Make sure the voting closing time is in UTC format. Use this script to generate it.
- Make sure the email is in text format.
Once the vote is done, you should also send out a summary e-mail with the totals (subject “[RESULT] [VOTE]...”).

[VOTE] Release Apache Spark 0.9.1 (rc1)

Please vote on releasing the following candidate as Apache Spark version 0.9.1
A draft of the release notes along with the CHANGES.txt file is attached to this e-mail.
The tag to be voted on is v0.9.1-rc1 (commit 81c6a06c):
https://git-wip-us.apache.org/repos/asf?p=spark.git;a=commit;h=81c6a06c796a87aaeb5f129f36e4c3396e27d652
The release files, including signatures, digests, etc can be found at:
http://people.apache.org/~tdas/spark-0.9.1-rc1/
Release artifacts are signed with the following key:
https://people.apache.org/keys/committer/tdas.asc
The staging repository for this release can be found at:
https://repository.apache.org/content/repositories/orgapachespark-1007/
The documentation corresponding to this release can be found at:
http://people.apache.org/~tdas/spark-0.9.1-rc1-docs/
Please vote on releasing this package as Apache Spark 0.9.1!
The vote is open until Thursday, September 19th at 05:00 UTC and passes if
a majority of at least 3 +1 PMC votes are cast.
[ ] +1 Release this package as Apache Spark 0.9.1
[ ] -1 Do not release this package because ...
To learn more about Apache Spark, please see
http://spark.apache.org/

Cutting the Official Release

Performing the Final Release in Nexus

Be Careful!

Make sure you chose the correct staging repository. THIS STEP IS IRREVERSIBLE.

Find the staging repository and click "Release" and confirm.

Uploading Final Source and Binary Artifacts