Versions Compared

Old Version 66

changes.mady.by.user Christophe Taton

Saved on

compared with

New Version 67

changes.mady.by.user Christophe Taton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

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

Table of Contents

Branching

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

  1. Update CHANGES.txt to include the release version and date (use Unreleased for the date if it is unknown) and remove Trunk (unreleased changes).

  2. Commit these changes to trunk.

    No Format
    svn commit -m "Preparing for release X.Y.Z"

  3. Create a branch for the release series:

    No Format
    svn copy https://svn.apache.org/repos/asf/avro/trunk \
https://svn.apache.org/repos/asf/avro/branches/branch-X.Y -m "Branching for X.Y releases"
  4. Update CHANGES.txt to add back in Trunk (unreleased changes).
  5. Update the default version in share/VERSION.txt on trunk to X.Y+1.0-SNAPSHOT. Be sure not to leave a trailing newline.

  6. Update the version in the Maven POM files to match with

    No Format
    mvn versions:set -DnewVersion=X.Y+1.0-SNAPSHOT -DgenerateBackupPoms=false

  7. Commit these changes to trunk.

    No Format
    svn commit -m "Preparing for X.Y+1.0 development"

Updating Release Branch

These operations take place in the release branch.

  1. Check out the branch with:

    No Format
    svn co https://svn.apache.org/repos/asf/avro/branches/branch-X.Y
  2. Update CHANGES.txt to include the release version and date (this change must be committed to trunk and any intermediate branches between trunk and the branch being released).
  3. Update the version number in share/VERSION.txt to be ''avro-X.Y.Z-SNAPSHOT''. Be sure not to leave a trailing newline.

  4. Update the version in the Maven POM files to match with

    No Format
    mvn versions:set -DnewVersion=X.Y.Z-SNAPSHOT -DgenerateBackupPoms=false

  5. Commit these changes.

    No Format
    svn commit -m "Preparing for release X.Y.Z"
  6. Add the fix version X.Y.Z to the Avro JIRA

  7. If not already done, merge desired patches from trunk into the branch and commit these changes. You can find the revision numbers using svn log CHANGES.txt in the branch and in trunk.

    No Format
    cd branch-X.Y
svn merge -rR1:R2 ../trunk .
svn commit -m "Merge -r R1:R2 from trunk to X.Y branch. Fixes: AVRO-A, AVRO-B."
  8. For each patch merged, change the fix version for the JIRA issue to be X.Y.Z
  9. Go through CHANGES.txt, JIRA, and svn log to be sure that the issues included in the branch match in each location, then update the date in CHANGES.txt to be today.
  10. Update the version number in share/VERSION.txt to be ''X.Y.Z''. Be sure not to leave a trailing newline.

  11. Update the version in the Maven POM files to match with

    No Format
    mvn versions:set -DnewVersion=X.Y.Z -DgenerateBackupPoms=false

  12. Tag the release candidate (R is the release candidate number):

    No Format
    svn copy https://svn.apache.org/repos/asf/avro/branches/branch-X.Y \
https://svn.apache.org/repos/asf/avro/tags/release-X.Y.Z-rcR -m "Avro X.Y.Z-rcR release."

Building

  1. Build the release & run unit tests.

    No Format
    ./build.sh clean dist test
  2. Check that release files look ok - e.g. unpack the sources and run tests.

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

    No Format
    ./build.sh sign

To sign a release, your key must be present in the dist/KEYS file. See the Apache guide to Signing Releases for more details. Also, if you've updated the dist/KEYS file, be sure to update the public Apache KEYS file as well:

Code Block
ssh people.apache.org
cd /www/www.apache.org/dist/avro
svn up

  1. Copy release files to a public place.

    No Format
    ssh people.apache.org mkdir public_html/avro-X.Y.Z-rcR
scp -pr dist/* people.apache.org:public_html/avro-X.Y.Z-rcR

  2. Stage two versions of Java artifacts to the Maven repository:

    No Format
    mvn clean -P dist,sign deploy -DskipTests=true -Dhadoop.version=2 -Dgpg.passphrase=XXX -Davro.version=X.Y.Z
mvn clean -P dist,sign deploy -DskipTests=true -Dgpg.passphrase=XXX -Davro.version=X.Y.Z

    Find the Staging Repository, and close it.

  3. Call a release vote on dev at avro.apache.org.
    Include the URL of the staging repository.

Publishing

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

  1. Tag the release:

    No Format
    svn move https://svn.apache.org/repos/asf/avro/tags/release-X.Y.Z-rcR \
https://svn.apache.org/repos/asf/avro/tags/release-X.Y.Z -m "Avro X.Y.Z release."

  2. Copy release files to the distribution directory and make them writable by the avro group.

    No Format
    ssh people.apache.org
cp -pr public_html/avro-X.Y.Z-rcR /www/www.apache.org/dist/avro/avro-X.Y.Z
cd /www/www.apache.org/dist/avro
chgrp -R avro avro-X.Y.Z
chmod -R g+w avro-X.Y.Z

  3. The release directory usually contains just two releases, the most recent from two branches, with a link named 'stable' to the most recent recommended version.

    No Format
    ssh people.apache.org
cd /www/www.apache.org/dist/avro
rm -rf avro-A.B.C; rm stable
ln -s avro-A.B.D stable
  4. Publish Java artifacts to the Maven repository:
    Find the Staging Repository and release it.

  5. Publish Python artifacts to PyPI

    No Format
    mkdir tmp/py
cd tmp/py
tar xzf ../../dist/py/avro-X.Y.X.tar.gz
cd avro-X.Y.Z
python setup.py sdist upload

  6. Publish Python3 artifacts to PyPI

    No Format
    mkdir -p tmp/py3
cd tmp/py3
tar xvf ../../dist/py3/avro-python3-X.Y.Z.tar.gz
cd avro-python3-X-Y-Z
python3 ./setup.py sdist upload

  7. Publish Ruby artifacts to RubyGems

    No Format
    gem push dist/ruby/avro-X.Y.Z.gem
  8. Wait 24 hours for release to propagate to mirrors.

  9. Prepare to edit the website.

    No Format
    svn co https://svn.apache.org/repos/asf/avro/site
  10. Update the documentation links in author/content/xdocs/site.xml.
  11. Update the release news in author/content/xdocs/releases.xml.

  12. Regenerate the site, review it, then commit it.

    No Format
    cd site
ant
firefox publish/index.html
svn commit -m "Updated site for release X.Y.Z."

  13. Copy the new release docs to website and update the docs/current link:

    No Format
    tar xzf dist/avro-doc-X.Y.Z.tar.gz
mv avro-doc-X.Y.Z ../site/publish/docs/X.Y.Z
cd ../site/publish
svn add X.Y.Z
rm current
ln -s X.Y.Z current
svn commit -m "Adding documentation for release X.Y.Z."
  14. Send announcements to the user and developer lists once the site changes are visible.
  15. Update the version number in share/VERSION.txt to be ''avro-X.Y.N-SNAPSHOT'', where ''N'' is one greater than the release just made.

  16. Update the version in the Maven POM files to match with

    No Format
    mvn versions:set -DnewVersion=X.Y.N-SNAPSHOT -DgenerateBackupPoms=false
  17. In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
  18. In Jira, "release" the version. Visit the "Administer Project" page, then the "Manage versions" page. You need to have the "Admin" role in Avro's Jira for this step and the next.
  19. In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.

Using AWS for Avro Build and Release

I've chosen the instance ID of ami-2d4aa444, which is the 32-bit Lucid Lynx with instance storage in us-east-1 (see http://uec-images.ubuntu.com/releases/lucid/release for other options in the Lucid Lynx family). Be sure to open port 80 in the security group under which you start the instance, as Javadoc needs to fetch remote documentation. Once you've started and ssh'ed into the instance, execute the below bash commands. Note also that you'll need to navigate Sun/Oracle's sweet user interface for installation. I've found it easiest to use tab to move to the "OK" box and space to select "OK".

Code Block
# If you want to check out code and edit it with emacs
sudo apt-get install emacs23-lucid subversion

# C dependencies
sudo apt-get install gcc automake libtool asciidoc

# C++ dependencies
sudo apt-get install g++ libboost-all-dev source-highlight flex bison doxygen

# Ruby dependencies
sudo apt-get install ruby ruby-dev rake rubygems libopenssl-ruby
sudo gem install echoe yajl-ruby

# Python dependencies
sudo apt-get install python-pip
sudo pip install setuptools

# Java dependencies
sudo add-apt-repository "deb http://archive.canonical.com/ lucid partner"
sudo apt-get update
sudo apt-get install ant sun-java6-jdk
sudo update-java-alternatives -s java-6-sun

To build the documentation for the distribution, you need to have Java 5 for use with Apache Forrest. Instructions for the installation are at http://java.sun.com/j2se/1.5.0/install-linux.html, and the binary installation file is available for download at http://java.sun.com/javase/downloads/5u22/jdk. You'll also need to download Forrest, currently available as a tarball at http://apache.siamwebhosting.com/forrest/apache-forrest-0.8.tar.gz. Lastly, you'll want to update your ~/build.properties file to tell Ant where to find Java 5 and Forrest; for example:

Code Block
java5.home=/home/ubuntu/jdk1.5.0_22
forrest.home=/home/ubuntu/apache-forrest-0.8

Be sure to set the JAVA_HOME environment variable explicitly.

See Also