How to release Apache Apex

For general information on ASF releases, see:

Creating Release Branch

If this is a minor release (X.Y.0), start with creating a new branch. Example for 3.4.0:

git checkout master && git pull
git checkout -b release-3.4 master
git push apache release-3.4

Replace version in master branch:

git checkout master
git grep -l "3.4.0-SNAPSHOT"

For informational purpose, this should yield the list of files that needs the version number replaced to X.(Y+1).0 next version. Note that the replacement step is different between the repositories due to an open issue. See:

For -core:

for a in `git grep -l "${dv}"`; do echo $a; sed -i 's/'"${dv}"'/'"${rv}"'/g' $a; done

For -malhar:

mvn versions:set -DnewVersion=${rv} -Pall-modules

Commit and push the change:

git commit --author "Apex Dev <>" -am "Preparing for 3.5.0 development"
git push apache master

Preparing Release Candidate

git checkout release-3.4

Add missing @since tags

For Java classes added since the last release, the @since tags need to be added. The javadoc plugin inserts missing tags, but does not play well with the license header when no class level documentation block is present. This is tracked as

It also removes the custom @tags doclet tag when the existing JavaDoc is malformed, do not use this to make changes in Malhar. Until these problems are resolved, use the following Ruby script to do the replacement:

ruby ~/add-since.rb `pwd` -s 3.4.0


Navigate to the unreleased version, example:

Obtain the release notes (text mode):

Shorten any wrapping and overly long titles to fit width. Copy the report and insert new release section into with the release date set to 72 hours ahead to reflect the time for the vote.

Create shortlink for the JIRA release notes on for use in the VOTE thread. Example:

Commit tags and change log:

git commit --author "Apex Dev <>" -am "Add @since tags and update change log for release 3.4.0"

Update version number for RC


As mentioned earlier, use the following for -core releases:

for a in `git grep -l "${dv}"`; do echo $a; sed -i 's/'"${dv}"'/'"${rv}"'/g' $a; done

And this for -malhar releases:

mvn versions:set -Pall-modules -DnewVersion=${rv}

Commit version change:

git commit --author "Apex Dev <>" -am "Preparing to release ${rv}-RC1"
git tag -a "v${rv}-RC1" -m "Release ${rv}-RC1"

Push to fork (as temporary branch), open pull request, wait for Travis CI build to succeed. Then push the tag.

git push apache "v${rv}-RC1"

The only difference between release branch and tag are this final version number change and the change log commit. The branch stays at -SNAPSHOT version.

Build and Deploy Release Candidate


Build and deploy release candidate from RC tag:

git checkout "v${rv}-RC1"
git clean -d -f
mvn clean apache-rat:check deploy -Papache-release -Pall-modules -DskipTests

Some recent versions of the GPG might result in the following error message when the above maven deploy command is invoked.

gpg: signing failed: Inappropriate ioctl for device

Setting the GPG terminal fixes this. GPG terminal can be set using

export GPG_TTY

Confirm no archives are included in source release (rat:check reports them in target/rat.txt but does not fail the build):

unzip -l target/* | grep -e ".zip\|.jar"

Log on to and look for Staging Repositories. "Close" the newly created orgapacheapex-xxxx staging repository to obtain the temporary URL, note it down for the VOTE thread.

Example URL:

Copy files to distribution dir and create signatures and checksums. (Note this is per policy to stage these files outside of the Maven repository, otherwise everything below would happen automatically as defined in the parent POM.)

For -core releases:


For -malhar releases:

cd target
md5sum ${RNAME}-source-release.tar.gz > ${RNAME}-source-release.tar.gz.md5
md5sum ${RNAME} > ${RNAME}
shasum -a 512 ${RNAME}-source-release.tar.gz > ${RNAME}-source-release.tar.gz.sha512
shasum -a 512 ${RNAME} > ${RNAME}
gpg --yes --armor --output ${RNAME}-source-release.tar.gz.asc --detach-sig ${RNAME}-source-release.tar.gz
gpg --yes --armor --output ${RNAME} --detach-sig ${RNAME}

Check files into the dist staging area:

mkdir svn-dist && cp *-source-* svn-dist/
svn import svn-dist${RNAME}-RC1 -m "Apache Apex v${rv}-RC1"

Build and Deploy Documentation


Javadoc will be automatically deployed for registered branches. For minor releases, add the new branch to the buildbot configuration:

User Documentation

The documentation will be generated as static HTML files into the apex-site repository, separated by version (X.Y).

Note You need Python 2.7+ and mkdocs with patch for issue mkdocs #859 on top of the currently available version 0.15.3. After installing mkdocs with pip, run the following to obtain this build:

sudo pip install --upgrade git+

Do the following setup steps before building and deploying the documentation.

  1. Clone the apex-site repository into a folder called apex-site at the same level as the current repository.

  2. Set the following environment variables.

    For -core releases:


    For -malhar releases:


    The REPO_NAME variable above should match the folder name of the cloned apex module being built.

Build and deploy the documentation in the release directory:

# build docs in ${REPO_NAME}, they will be generated in a site sub-folder
mkdocs build --clean

# Calculate the major.minor version
docv=`echo ${rv} | sed 's/\([0-9]*\)\.\([0-9]*\)\.\([0-9]*\)/\1\.\2/'`

# copy docs from site folder into target folder on apex-site
cd ../apex-site
git checkout asf-site
rm -rf docs/${DOC_NAME}-${docv}
cp -r ../${REPO_NAME}/site docs/${DOC_NAME}-${docv}
git add -A
git commit --author "Apex Dev <>" -m "Adding ${DOC_NAME}-${rv} documentation"
git push

After publishing the site the new documentation will be available at${DOC_NAME}-${docv}/


Vote call sample:

Vote result:

Note that the vote result email should have the subject prefixed with [RESULT].

If the vote is not successful, a new RC needs to be built and new vote called. Once the PMC vote passes, proceed with promoting and announcing the release.

Promote Release

Release Nexus staging repository:

Move source release from dist staging to release folder (to be done by PMC member):

svn mv${RNAME}-RC1${RNAME} -m "Release ${RNAME}"


Close release and all associated tickets (use bulk change workflow transition and turn off notification at bottom of page to not flood the mailing list). Create version number X.Y.Z+1 for next release (to be done by PMC member).


Create final release tag:

git tag -a "v${rv}" -m "Release ${rv}" "v${rv}-RC2"
git push apache "v${rv}"

Cherry-pick @since tag and change log commit from release tag and bump patch version number in release branch (X.Y.Z+1 - otherwise same as when creating new release branch):

git checkout release-3.4
for a in `git grep -l "${dv}"`; do echo $a; sed -i 's/'"${dv}"'/'"${rv}"'/g' $a; done

If there are new artifacts published to Maven repositories consider enabling semantic versioning check for the newly published libraries.

Commit all changes and push them to the remote git repository:

git commit --author "Apex Dev <>" -am "Preparing for 3.4.1 development"
git push apache

Cherry-pick @since tag and change log changes from release tag to master.


If this is a minor or a major release, link the release documentation as latest on the web site. Otherwise it is a patch release and this step can be skipped (documentation is already reflected in the website).

Under the apex-site folder (asf-site branch):

# docv major.minor version calculated in the build step
cd docs
# Set the release version to be the latest available version
ln -nsf ${DOC_NAME}-${docv} ${DOC_NAME}
git add -A
git commit --author "Apex Dev <>" -m "Promoting ${DOC_NAME}-${docv} documentation"
git push

Update Web Site

Update the download page to reflect the new release:

Publish the web site, see apex-site repository for instructions.

Announce Release

Send the announcement email, example:

Removing old Releases

As part of publishing new releases, please determine whether old releases should be deleted. See release archiving policy for details why.

With a new patch release, the previous patch release can be removed. For example, once 3.4.1 patch is released, we no longer need to have 3.4.0 on the download page.

Once a release branch is no longer supported, we can also remove the last release in that line. For example once release-3.4 branch is EOL, releases 3.4.1 (or whatever the latest patch was) can be removed from downloads.