This page is to document the release procedure for Pig. Pig is a fairly young Apache project. Its release process is work in progress and is modeled from Hadoop Release Procedure.
Note that only Pig committers can create a release.
Preparation
TODO:
- Define issue management process like assigning/removing issues from release.
Creating Release Branch
We only branch for major (X.0.0) and minor(X.Y.0) releases but not for patches (X.Y.Z). Patch is an update to an existing branch created for X.Y.0.
- Send email to
dev@pig.apache.org
to notify that you about to branch the tree and ask to hold off any commits till this is finished. - Update
CHANGES.txt
to include the release version and date (useUnreleased
for the date if it is unknown) and removeTrunk (unreleased changes)
. Below is the example of the top of theCHANGES.txt
file after the update:Pig Change Log Release 0.1.1 - Unreleased INCOMPATIBLE CHANGES NEW FEATURES IMPROVEMENTS PIG-253: integration with hadoop-18 BUG FIXES PIG-342: Fix DistinctDataBag to recalculate size after it has spilled. (bdimcheff via gates)
- Edit
src/docs/src/documentation/content/xdocs/site.xml
. In the external reference for api where the link contains the previous version number change this string to the correct version number. - Commit these changes to trunk:
svn commit -m "Preparing for release X.Y.Z"
- Create a branch for the release series:
svn copy https://svn.apache.org/repos/asf/pig/trunk \ https://svn.apache.org/repos/asf/pig/branches/branch-X.Y -m "Branching for X.Y releases"
- Update CHANGES.txt to add back in Trunk (unreleased changes). Top of the
CHANGES.txt
should look like this now:Pig Change Log Trunk (unreleased changes) INCOMPATIBLE CHANGES IMPROVEMENTS OPTIMIZATIONS BUG FIXES Release 0.1.1 - Unreleased ....
- Update the default version in
build.xml
on trunk to X.Y+1.0-dev. - Commit these changes to trunk:
svn commit -m "Preparing for X.Y+1.0 development"
Updating Release Branch
The steps in this section are needed for all the releases (major, minor, and patches).
- Check out the branch with:
svn co https://svn.apache.org/repos/asf/pig/branches/branch-X.Y
- Run rat report and make sure that all files that can have apache license agreement.
ant releaseaudit
- For patches, update CHANGES.txt to include the release version and date. See #2 from Create Release Branch section.
- Update RELEASE_NOTES.txt for this release:
- Make sure to change all of the version number references to the current version number.
- Note highlights for this release. CHANGES.txt is a great place to find these.
- Note incompatibilities for this release. These should be listed under INCOMPATIBLE CHANGES in CHANGES.txt.
- Update the version number in
build.xml
to be X.Y.N-SNAPSHOT, where N is one greater than the release being made. - Update pig.version in libraries.properties to X.Y.Z
- Commit these changes:
svn commit -m "Preparing for release X.Y.Z"
- Tag the release candidate:
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
- Build and run unit tests:
ant clean ant jar test
- Check that contrib and tutorial directories compile and tests pass:
cd contrib/zebra ant ant test cd ../.. cd contrib/piggybank/java ant ant test cd ../../../tutorial ant
- Build the source release:
ant -Dversion=X.Y.Z src-release
- Test the source tar file by unpacking the release and
- building pig.jar:
ant
- building and running tutorial
cd tutorial ant
- build piggybank
cd contrib/piggybank/java ant ant test
- running unit tests
ant test-commit
- building pig.jar:
- Build the convenience artifacts:
ant clean ant test ant clean ant jar cd contrib/zebra ant cd ../.. cd contrib/piggybank/java ant cd ../../.. 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)
- Generate the MD5 checksum of the release artifact and convenience binaries:
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
- If you do not have a gpg key pair, do the following steps:
- Generating key pair using the following command. You can simply accept all default settings and give your name, email and Passphase.
gpg --gen-key
- Export your public key.
gpg --armor --output pubkey.txt --export 'Your Name'
- Open pubkey.txt, copy the full text and append it to the following files by pasting, then commit these changes:
https://svn.apache.org/repos/asf/pig/branches/branch-X.Y.Z/KEYS https://svn.apache.org/repos/asf/pig/trunk/KEYS
- Upload updated KEYS to Apache.
scp KEYS people.apache.org:/www/www.apache.org/dist/pig/KEYS
- Export your private key, keep it with you.
gpg --export-secret-key -a "Your Name" > private.key
- Generating key pair using the following command. You can simply accept all default settings and give your name, email and Passphase.
- Sign the release artifact only (see Step-By-Step Guide to Mirroring Releases for more information).
gpg --armor --output pig-X.Y.Z-src.tar.gz.asc --detach-sig pig-X.Y.Z-src.tar.gz
- Verify gpg signature.
gpg --import KEYS (if necessarily) gpg --verify pig-X.Y.Z-src.tar.gz.asc pig-X.Y.Z-src.tar.gz
- Copy release artifact, convenience binaries, release notes and the rat report to a public place (usually into public_html in your home directory):
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 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
- Push proposed release to Maven staging area
- Create file ~/.m2/settings.xml with following contents (NOTE: It is highly recommended to use Maven's password encryption capabilities for your passwords.):
<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>
- Run ant command
ant mvn-deploy
to publish Pig artifacts to the apache snapshot repository. - Run ant command
ant –Drepo=staging –Dversion=X.Y.Z mvn-deploy
to publish Pig artifacts to the apache staging repository.
- Create file ~/.m2/settings.xml with following contents (NOTE: It is highly recommended to use Maven's password encryption capabilities for your passwords.):
- Call a release vote. The initial email should be sent to
dev@pig.apache.org
. Here is a sample of email: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 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
Forward the initial email to private@pig.apache.org
for Pig PMC members to vote.
Publish
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.
- Tag the release:
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."
- Copy release files to the distribution directory and make them writable by the pig group.
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
- 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.
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
- Push Maven release from staging to production
- Go to https://repository.apache.org/index.html#view-repositories;staging~browsestorage
- Log in, using your Apache LDAP credentials. The sign in link is in the upper right hand corner.
- 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.
- Select the appropriate artifacts for this release and click "Close" on the bar above the list of artifacts.
- Select the appropriate artifacts for this release and click "Release" on the bar above the list of artifacts.
- Wait 24 hours for release to propagate to mirrors.
- Prepare to edit the website.
svn co https://svn.apache.org/repos/asf/pig/site
- Update the front page news in author/src/documentation/content/xdocs/index.xml.
- Update the release news in author/src/documentation/content/xdocs/releases.xml.
- Update the documentation links in author/src/documentation/content/xdocs/site.xml
- Copy in the release specific documentation
cd publish mkdir docs/rX.Y.Z cp -pr <releasedir>/docs/* publish/docs/rX.Y.Z/ svn add publish/docs/rX.Y.Z
- Regenerate the site, review it and commit in HowToCommit.
- Deploy your site changes.
ssh people.apache.org cd /www/pig.apache.org umask 002 svn up
- Wait until you see your changes reflected on the Apache web site.
- 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.
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.
- In JIRA, mark the release as released.
- Goto JIRA and click on Administration tab.
- Select the Pig project.
- Select Manage versions.
- Select Release for the version you have released.
- 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.
- 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.
- In JIRA, mark the issues resolved in this release as closed.
- Goto JIRA and click on the "Search for Issues" on "Issues" menu.
- In the left hand Edit section, set Project to Pig.
- In Status select "Resolved"
- In Resolutions select "Fixed"
- Click "Search" button
- In the next screen, further select fix For select the version you are releasing.
- Click on the "Search" button
- Select "Tools->Bulk change all XX issues" (near the top right)
- Select all the issues and click on "Next"
- Select "Transition Issues" radio button and click on "Next"
- Select "Close Issue" radio button and click on "Next"
- 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".
- Click "Confirm". Don't worry if it gives you a HTTP 500 error, it still does the transitions.
- Update jdiff for next release (step 16 to 19).
svn co https://svn.apache.org/repos/asf/pig/trunk
- Open build.xml. Change this line:
<property name="jdiff.stable" value="X.Y-1.Z"/> To <property name="jdiff.stable" value="X.Y.Z"/>
- Copy jdiff comparison base to trunk
cp {releasedir}/lib/jdiff/pig_X.Y.Z.xml lib/jdiff
- TODO Need to integrate javadoc into this.
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"