superset/RELEASING

Apache Releases

Until things settle and we create scripts that streamline this, you'll probably want to run these commands manually and understand what they do prior to doing so.

For coordinating on releases, on operational topics that require more synchronous communications, we recommend using the #apache-releases channel on the Superset Slack. People crafting releases and those interested in partaking in the process should join the channel.

Release setup (First Time Only)

First you need to setup a few things. This is a one-off and doesn't need to be done at every release.

    # Create PGP Key, and use your @apache.org email address
    gpg --gen-key

    # Checkout ASF dist repo

    svn checkout https://dist.apache.org/repos/dist/dev/incubator/superset/ ~/svn/superset_dev

    svn checkout https://dist.apache.org/repos/dist/release/incubator/superset/ ~/svn/superset
    cd ~/svn/superset


    # Add your GPG pub key to KEYS file. Replace "Maxime Beauchemin" with your name
    export SUPERSET_PGP_FULLNAME="Maxime Beauchemin"
    (gpg --list-sigs "${SUPERSET_PGP_FULLNAME}" && gpg --armor --export "${SUPERSET_PGP_FULLNAME}" ) >> KEYS


    # Commit the changes
    svn commit -m "Add PGP keys of new Superset committer"

Crafting a source release

When crafting a new minor or major release we create a branch named with the release MAJOR.MINOR version (on this example 0.34). This new branch will hold all PATCH and release candidates that belong to the MAJOR.MINOR version.

The MAJOR.MINOR branch is normally a "cut" from a specific point in time from the master branch. Then (if needed) apply all cherries that will make the PATCH

Next update the CHANGELOG.md with all the changes that are included in the release. Make sure you have set your GITHUB_TOKEN environment variable.

# will overwrites the local CHANGELOG.md, somehow you need to merge it in
github-changes -o apache -r incubator-superset --token $GITHUB_TOKEN --between-tags <PREVIOUS_RELEASE_TAG>...<CURRENT_RELEASE_TAG>

Finally bump the version number on superset/static/assets/package.json:

    "version": "0.34.1"

Commit the change with the version number, then git tag the version with the release candidate and push to the branch

Setting up the release environment (do every time)

As the vote process takes a minimum of 72h (community vote) + 72h (IPMC) vote, often stretching over several weeks calendar time if votes don't pass, chances are the same terminal session won't be used for crafting the release candidate and the final release. Therefore, it's a good idea to do the following every time you work on a new phase of the release process to make sure you aren't releasing the wrong files/using wrong names. There's a script to help you set correctly all the necessary environment variables. Change you current directory to superset/RELEASING

    # usage: set_release_env.sh <SUPERSET_VERSION> <SUPERSET_VERSION_RC> "<PGP_KEY_FULLNAME>"
    . ./set_release_env.sh XX.YY.ZZ QQ "YOUR PGP KEY NAME"

The script will output the exported variables, for example for 0.34.1 RC1:

    -------------------------------
    Set Release env variables
    SUPERSET_VERSION=0.34.1
    SUPERSET_RC=1
    SUPERSET_PGP_FULLNAME=You PGP Key Name
    SUPERSET_VERSION_RC=0.34.1rc1
    SUPERSET_RELEASE=apache-superset-incubating-0.34.1
    SUPERSET_RELEASE_RC=apache-superset-incubating-0.34.1rc1
    SUPERSET_RELEASE_TARBALL=apache-superset-incubating-0.34.1-source.tar.gz
    SUPERSET_RELEASE_RC_TARBALL=apache-superset-incubating-0.34.1rc1-source.tar.gz
    -------------------------------

Preparing the release candidate

The first step of preparing an Apache Release is packaging a release candidate to be voted on. Make sure you have correctly prepared and tagged the ready to ship release on Superset's repo (MAJOR.MINOR branch), the following script will clone the tag and create a signed source tarball from it:

    # make_tarball you use the previouly set environment variables
    # you can override by passing arguments: make_tarball.sh <SUPERSET_VERSION> <SUPERSET_VERSION_RC> "<PGP_KEY_FULLNAME>"
    ./make_tarball.sh

Note that make_tarball.sh:

• By default assumes you have already executed an SVN checkout to $HOME/svn/superset_dev. This can be overriden by setting SUPERSET_SVN_DEV_PATH environment var to a different svn dev directory
• Will refuse to craft a new release candidate if a release already exists on your local svn dev directory
• Will check package.json version number and fails if it's not correctly set

Build and test the created source tarball

To build and run the just created tarball

    # Build and run a release candidate tarball
    ./test_run_tarball.sh local
    # you should be able to access localhost:5001 on your browser
    # login using admin/admin

Shipping to SVN

Now let's ship this RC into svn's dev folder

    cd ~/svn/superset_dev/
    svn add ${SUPERSET_VERSION_RC}
    svn commit -m "Release ${SUPERSET_VERSION_RC}"

Build and test from SVN source tarball

To make a working build given a tarball

    # Build and run a release candidate tarball
    ./test_run_tarball.sh
    # you should be able to access localhost:5001 on your browser
    # login using admin/admin

Voting

Now you're ready to start the [VOTE] thread. Here's an example of a previous release vote thread: https://lists.apache.org/thread.html/e60f080ebdda26896214f7d3d5be1ccadfab95d48fbe813252762879@<dev.superset.apache.org>

Once 3+ binding votes (by PMC members) have been cast and at least 72 hours have past, you can post a [RESULT] thread: https://lists.apache.org/thread.html/50a6b134d66b86b237d5d7bc89df1b567246d125a71394d78b45f9a8@%3Cdev.superset.apache.org%3E

Following the result thread, yet another [VOTE] thread should be started at general@incubator.apache.org.

Announcing

Once it's all done, an [ANNOUNCE] thread announcing the release to the dev@ mailing list is the final step.

Validating a release

https://www.apache.org/info/verification.html

Publishing a successful release

Upon a successful vote (community AND IPMC), you'll have to copy the folder into the non-"dev/" folder.

    cp -r ~/svn/superset_dev/${SUPERSET_VERSION_RC}/ ~/svn/superset/${SUPERSET_VERSION}/
    cd ~/svn/superset/
    # Rename the RC (0.34.1rc1) to the actual version being released (0.34.1)
    for f in ${SUPERSET_VERSION}/*; do mv "$f" "${f/${SUPERSET_VERSION_RC}/${SUPERSET_VERSION}}"; done
    svn add ${SUPERSET_VERSION}
    svn commit -m "Release ${SUPERSET_VERSION}"

Then tag the final release:

    # Go to the root directory of the repo, e.g. `~/src/incubator-superset`
    cd ~/src/incubator-superset/
    # make sure you're on the correct branch (e.g. 0.34)
    git branch
    # Create the release tag
    git tag -f ${SUPERSET_VERSION}

Now you can announce the release on the mailing list, make sure to use the proper template

Publishing a Convenience Release to PyPI

From the root of the repo running ./pypi_push.sh will build the Javascript bundle and echo the twine command allowing you to publish to PyPI. You may need to ask a fellow committer to grant you access to it if you don't have access already. Make sure to create an account first if you don't have one, and reference your username while requesting access to push packages.

Post release

In UPDATING.md, a file that contains a list of notifications around deprecations and upgrading-related topics, make sure to move the content now under the Next Version section under a new section for the new release.

Refresh documentation website

Every once in a while we want to compile the documentation and publish it. Here's how to do it.

# install doc dependencies
pip install -r docs/requirements.txt

# build the docs
python setup.py build_sphinx

# copy html files to temp folder
cp -r docs/_build/html/ /tmp/tmp_superset_docs/

# clone the docs repo
cd ~/
git clone https://git-wip-us.apache.org/repos/asf/incubator-superset-site.git

# copy
cp -r /tmp/tmp_superset_docs/ ~/incubator-superset-site.git/

# commit and push to `asf-site` branch
cd ~/incubator-superset-site.git/
git checkout asf-site
git add .
git commit -a -m "New doc version"
git push origin master