Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We only branch for major (X.0.0) and minor(X.Y.0) releases but not for patches (X.Y.Z). Patch is and an update to an existing branch created for X.Y.0.

...

  1. Check out the branch with:
    Code Block
    svn co https://svn.apache.org/repos/asf/pig/branches/branch-X.Y
    
  2. Run rat report and make sure that all files that can have apache license agreement. Note that currently the rat report is part of output and needs to be manually extracted. TODO: write the report into a file.
    Code Block
    ant -Djava5.home=<java5 jdk dir> releaseaudit >out
    
  3. For patches, update CHANGES.txt to include the release version and date. See #2 from Create Release Branch section.
  4. Update RELEASE_NOTES.txt for this release:
    1. Make sure to change all of the version number references to the current version number.
    2. Note highlights for this release. CHANGES.txt is a great place to find these.
    3. Note incompatibilities for this release. These should be listed under INCOMPATIBLE CHANGES in CHANGES.txt.
  5. Update the version number in build.xml to be X.Y.N-SNAPSHOT, where N is one greater than the release being made.
  6. Update pig.version in libraries.properties to X.Y.Z
  7. Commit these changes:
    Code Block
    svn commit -m "Preparing for release X.Y.Z"
    
  8. Tag the release candidate:
    Code Block
    svn copy https://svn.apache.org/repos/asf/pig/branches/branch-X.Y \
    https://svn.apache.org/repos/asf/pig/tags/release-X.Y.Z-rcR -m "Pig X.Y.Z-rcR release."
    

Building

  1. Build the release and run unit tests:
    Code Block
    ant clean
    ant jar test
    
  2. Check that contrib and tutorial directories compile and tests pass:
    Code Block
    ant clean
    ant jar
    cd contrib/zebra
    ant
    ant test
    cd ../..
    cd contrib/piggybank/java
    ant
    ant test
    cd ../../../tutorial
    ant
    
  3. Build the source release:
    Code Block
    ant -Dversion=X.Y.Z -Dforrest.home=<Forrest installation dir>  tar
    ant -Dversion=X.Y.Z -Dforrest.home=<Forrest installation dir>  rpm (on a Fedora/Redhat system)
    ant -Dversion=X.Y.Z -Dforrest.home=<Forrest installation dir>  deb (on a Ubuntu/Debian system)
    src-release
    
  4. Test the source Test the tar file by unpacking the release and
    1. building pig.jar: ant
    2. building and running tutorial
      Code Block
      cd tutorial
      ant
      
    3. build piggybank
      Code Block
      cd contrib/piggybank/java
      ant
      ant test
      
    4. running unit tests ant test-commit
  5. Generate the MD5 checksum of the release fileBuild the convenience artifacts:
    Code Block
    
    ant clean
    ant test
    ant clean
    ant jar
    cd build
    md5sum pig-X.Y.Z.tar.gz > pig-X.Y.Z.tar.gz.md5
    md5sum pig-X.Y.Z-1.i386.rpm > pig-contrib/zebra
    ant
    cd ../..
    cd contrib/piggybank/java
    ant
    cd ../../..
    ant -Dversion=X.Y.Z -1.i386.rpm.md5
    md5sum pig-Dforrest.home=<Forrest installation dir>  tar
    ant -Dversion=X.Y.Z -1.i386.deb > md5sum pig-Dforrest.home=<Forrest installation dir>  rpm (on a Fedora/Redhat system)
    ant -Dversion=X.Y.Z -1.i386.deb.md5
    Dforrest.home=<Forrest installation dir>  deb (on a Ubuntu/Debian system)
    
  6. Generate the MD5 checksum of the release artifact and convenience binaries:
    Code Block
    
    cd build
    md5sum pig-X.Y.Z-src.tar.gz > pig-X.Y.Z-src.tar.gz.md5
    md5sum pig-X.Y.Z.tar.gz > pig-X.Y.Z.tar.gz.md5
    md5sum pig-X.Y.Z-1.i386.rpm > pig-X.Y.Z-1.i386.rpm.md5
    md5sum pig-X.Y.Z-1.i386.deb > md5sum pig-X.Y.Z-1.i386.deb.md5
    
  7. If you do not have a gpg key pair, do the following steps:
    1. Generating key pair using the following command. You can simply accept all default settings and give your name, email and Passphase
    If you do not have a gpg key pair, do the following steps:
    1. Generating key pair using the following command. You can simply accept all default settings and give your name, email and Passphase.
      Code Block
      
      gpg --gen-key
      
    2. Export your public key.
      Code Block
      
      gpg --armor --output pubkey.txt --export 'Your Name'
      
    3. Open pubkey.txt, copy the full text and append it to the following files by pasting, then commit these changes:
      Code Block
      
      https://svn.apache.org/repos/asf/pig/branches/branch-X.Y.Z/KEYS
      https://svn.apache.org/repos/asf/pig/trunk/KEYS
      
    4. Upload updated KEYS to Apache.
      Code Block
      
      scp KEYS people.apache.org:/www/www.apache.org/dist/pig/KEYS
      
    5. Export your private key, keep it with you.
      Code Block
      gpg --export-secret-key -a "Your Name" > private.key
      
    Sign the release (see Step-By-Step Guide to Mirroring Releases for more information)
    1. gen-key
      
    2. Export your public key.
      Code Block
      
      gpg --armor --output 
    pig-X.Y.Z.tar.gz.asc
    1. pubkey.txt --
    detach-sig pig-X.Y.Z.tar.gz gpg --armor --output pig
    1. export 'Your Name'
      
    2. Open pubkey.txt, copy the full text and append it to the following files by pasting, then commit these changes:
      Code Block
      
      https://svn.apache.org/repos/asf/pig/branches/branch-X.Y.Z/KEYS
      https://svn.apache.org/repos/asf/pig/trunk/KEYS
      
    3. Upload updated KEYS to Apache.
      Code Block
      
      scp KEYS people.apache.org:/www/www.apache.org/dist/pig/KEYS
      
    4. Export your private key, keep it with you.
      Code Block
      
      gpg --export-secret-key -a "Your Name" > private.key
      
  8. Sign the release artifact only (see Step-By-Step Guide to Mirroring Releases for more information)-1.i386.rpm.asc --detach-sig pig-X.Y.Z-1.i386.rpm gpg --armor --output pig-X.Y.Z-1.i386.deb.asc --detach-sig pig-X.Y.Z-1.i386.deb Verify gpg signature.
    Code Block
    gpg --import KEYS  (if necessarily)
    gpgarmor --verifyoutput pig-X.Y.Z-src.tar.gz.asc --detach-sig pig-X.Y.Z-src.tar.gz
    
    
  9. Verify gpg signature.
    Code Block
    gpg --verify pig-X.Y.Z-1.i386.rpm.asc pig-X.Y.Z-1.i386.rpmimport KEYS  (if necessarily)
    gpg --verify pig-X.Y.Z-1src.i386tar.debgz.asc pig-X.Y.Z-1src.i386tar.debgz
    
  10. Copy release files release artifact, convenience binaries, release notes and the rat report to a public place (usually into public_html in your home directory):
    Code Block
    ssh people.apache.org mkdir public_html/pig-X.Y.Z-candidate-0
    scp -p pig-X.Y.Z* people.apache.org:public_html/pig-X.Y.Z-candidate-0
    cd ..
    scp RELEASE_NOTES.txt_NOTES.txt people.apache.org:public_html/pig-X.Y.Z-candidate-0
    scp <rat_report> people.apache.org:public_html/pig-X.Y.Z-candidate-0
    
  11. Push proposed release to Maven staging area
    1. Create file ~/.m2/settings.xml with following contents (NOTE: It is highly recommended to use Maven's password encryption capabilities for your passwords.):
      Code Block
      <settings>
        <servers>
          <server>
            <id>apache.releases.https</id>
            <username>your apache id</username>
            <password>your apache password</password>
          </server>
          <server>
            <id>apache.snapshots.https</id>
            <username>your apache id</username>
            <password>your apache password</password>
          </server>
          <server>
            <id>apache.staging.https</id>
            <username>your apache id</username>
            <password>your apache password</password>
          </server>
        </servers>
      
        <profiles>
          <profile>
            <id>apache-release</id>
            <properties>
              <gpg.passphrase>your GPG password</gpg.passphrase>
            </properties>
          </profile>
        </profiles>
      </settings>
      
    2. Run ant command ant mvn-deploy to publish Pig artifacts to the apache snapshot repository.
    3. Run ant command ant –Drepo=staging –Dversion=X.Y.Z mvn-deploy to publish Pig artifacts to the apache staging repository.
  12. Call a release vote. The initial email should be sent to dev@pig.apache.org. Make sure to attache rat report to it. Here is a sample of email:
    Code Block
    From: Olga Natkovich [mailto:olgan@yahoo-inc.com] 
    Sent: Tuesday, November 25, 2008 3:59 PM
    To: dev@pig.apache.org
    Subject: [VOTE] Release Pig 0.1.1 (candidate 0)
    
    Hi,
    
    I have created a candidate build for Pig 0.1.1. This release is almost identical to Pig 0.1.0 with a couple of exceptions:
    
    (1) It is integrated with hadoop 18
    (2) It has one small bug fix (PIG-253)
    (3) Several UDF were added to piggybank - pig's UDF repository
    
    The rat report is attached.
    
    Keys used to sign the release are available at http://svn.apache.org/viewvc/pig/trunk/KEYS?view=markup.
    
    Please download, test, and try it out:
    
    http://people.apache.org/~olga/pig-0.1.1-candidate-0
    
    Release notes and the rat report are available from the same location.
    
    Should we release this? Vote closes on Wednesday, December 3rd.
    
    Olga
    

...

Once three PMC members have voted for a release and a majority vote to release and the required 3 days have passed, it may be published.

  1. Tag the release:
    Code Block
    svn move https://svn.apache.org/repos/asf/pig/tags/release-X.Y.Z-rcR \
    https://svn.apache.org/repos/asf/pig/tags/release-X.Y.Z -m "Pig X.Y.Z release."
    
  2. Copy release files to the distribution directory and make them writable by the pig group.
    Code Block
    ssh people.apache.org
    cp -pr public_html/pig-X.Y.Z-candidate-0 /www/www.apache.org/dist/pig/pig-X.Y.Z
    cd /www/www.apache.org/dist/pig
    chgrp -R pig pig-X.Y.Z
    chmod -R g+w pig-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.
    Code Block
    ssh people.apache.org
    cd /www/www.apache.org/dist/pig
    rm -rf pig-A.B.C; rm stable
    ln -s pig-A.B.D stable
    
  4. Push Maven release from staging to production
    1. Go to https://repository.apache.org/index.html#view-repositories;staging~browsestorage
    2. Log in, using your Apache LDAP credentials. The sign in link is in the upper right hand corner.
    3. In the frame on the left side of the page, select "Staging Repositories", you should now see a list of artifacts in the main frame.
    4. Select the appropriate artifacts for this release and click "Close" on the bar above the list of artifacts.
    5. Select the appropriate artifacts for this release and click "Release" on the bar above the list of artifacts.
  5. Wait 24 hours for release to propagate to mirrors.
  6. Prepare to edit the website.
    Code Block
    svn co https://svn.apache.org/repos/asf/pig/site
    
  7. Update the front page news in author/src/documentation/content/xdocs/index.xml.
  8. Update the release news in author/src/documentation/content/xdocs/releases.xml.
  9. Update the documentation links in author/src/documentation/content/xdocs/site.xml
  10. Copy in the release specific documentation
    Code Block
        cd publish
        mkdir docs/rX.Y.Z
        cp -pr <releasedir>/docs/* publish/docs/rX.Y.Z/
        svn add publish/docs/rX.Y.Z
    
  11. Regenerate the site, review it and commit in HowToCommit.
  12. Deploy your site changes.
    Code Block
    ssh people.apache.org
    cd /www/pig.apache.org
    umask 002
    svn up
    
  13. Wait until you see your changes reflected on the Apache web site.
  14. Send announcements to the user and developer lists as well as (dev@pig.apache.org; user@pig.apache.org; announce@apache.org; announce@haoop.apache.org) once the site changes are visible.
    Code Block
    Pig  team is happy to announce Pig X.Y.Z release. 
    
    Apache Pig provides a high-level data-flow language and execution framework for parallel computation on Hadoop clusters.
    More details about Pig can be found at http://pig.apache.org/.
    
    The highlights of this release are ... The details of the release can be found at http://pig.apache.org/releases.html.
    
  15. In JIRA, mark the release as released.
    1. Goto JIRA and click on Administration tab.
    2. Select the Pig project.
    3. Select Manage versions.
    4. Select Release for the version you have released.
    5. If a description has not yet been added for the version you are releasing, select Edit Details and give a brief description of the release.
    6. If the next version does not exist (that is, if you are releasing version 0.x, if version 0.x+1 does not yet exist) create it using the Add Version box at the top of the page.
  16. In JIRA, mark the issues resolved in this release as closed.
    1. Goto JIRA and click on the "Search for Issues" on "Issues" menu.
    2. In the left hand Edit section, set Project to Pig.
    3. In Status select "Resolved"
    4. In Resolutions select "Fixed"
    5. Click "Search" button
    6. In the next screen, further select fix For select the version you are releasing.
    7. Click on the "Search" button
    8. Select "Tools->Bulk change all XX issues" (near the top right)
    9. Select all the issues and click on "Next"
    10. Select "Transition Issues" radio button and click on "Next"
    11. Select "Close Issue" radio button and click on "Next"
    12. Uncheck the box near the bottom at says "Send mail for this update" lest you spam every Pig developer with a message for every bug resolved in this release. Click "Next".
    13. Click "Confirm". Don't worry if it gives you a HTTP 500 error, it still does the transitions.
  17. Update jdiff for next release (step 16 to 19).
    Code Block
       svn co https://svn.apache.org/repos/asf/pig/trunk
    
  18. Open build.xml. Change this line:
    Code Block
    <property name="jdiff.stable" value="X.Y-1.Z"/>
    To
    <property name="jdiff.stable" value="X.Y.Z"/>
    
  19. Copy jdiff comparison base to trunk
    Code Block
    cp {releasedir}/lib/jdiff/pig_X.Y.Z.xml lib/jdiff
    
  20. Code Block
    svn add lib/jdiff/pig_X.Y.Z.xml
    svn remove lib/jdiff/pig_X.Y-1.Z.xml
    svn commit -m "Jdiff change for X.Y.Z"
    
    TODO Need to integrate javadoc into this.