THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
This document describes how to make a release of Sqoop. It is a work in progress and should be refined by the Release Manager (RM) as they come across aspects of the release process not yet documented here.
NOTE: For the purpose of illustration, this document assumes that the version being released is 1.4.0-incubating, and the following development version will become 1.4.1-incubating.
Prerequisites
Policy documents
The policy on releasing artifacts from an incubating Apache project is stated in the Guide to Release Management During Incubation. If any stated tasks in this document conflict with what is stated in the policy document, it must be brought to the notice of PPMC for further resolution.
The Release Manager (RM) must go through the policy document to understand all the tasks and responsibilities of running a release.
Give a heads up
The RM should first create an umbrella issue and then setup a timeline for release branch point. The time for the day the umbrella issue is created to the release branch point must be at least two weeks in order to give the community a chance to prioritize and commit any last minute features and issues they would like to see in the upcoming release.
The RM should then send the pointer to the umbrella issue along with the tentative timeline for branch point to the user and developer lists. Any work identified as release related that needs to be completed should be added as a subtask of the umbrella issue to allow users to see the overall release progress in one place.
TODO: Add an email template to send out
Sanitize JIRA
Before a release is done, make sure that any issues that are fixed have their fix version setup correctly. Run the following JIRA query to see which resolved issues do not have their fix version set up correctly:
project = sqoop and resolution = fixed and fixVersion is empty
The result of the above query should be empty. If some issues do show up in this query that have been fixed since the last release, please bulk-edit them to set the fix version to '1.4.0-incubating'.
You can also run the following query to make sure that the issues fixed for the to-be-released version look accurate:
project = sqoop and resolution = fixed and fixVersion = '1.4.0-incubating'
Monitor active issues
It is important that between the time that the umbrella issue is filed to the time when the release branch is created, no experimental or potentially destabilizing work is checked into the trunk. While it is acceptable to introduce major changes, they must be thoroughly reviewed and have good test coverage to ensure that the release branch does not start of being unstable.
If necessary the RM can discuss if certain issues should be fixed on the trunk in this time, and if so what is the gating criteria for accepting them.
Creating Release Artifacts
Communicate with the community
1. Send an email to sqoop-dev@incubator.apache.org to
- Notify that you are about to branch.
- Ask to hold off any commits until this is finished.
2. Send another email after branching is done.
Create a release branch
1. Checkout the trunk.
svn co https://svn.apache.org/repos/asf/incubator/sqoop/trunk
2. Update CHANGES.txt in the trunk.
- For example,
Apache Sqoop Change Log
Release 1.4.0
NEW FEATURES
SQOOP-305 Support export from Avro Data Files
...
3. Update the "version" value of build.xml in trunk to "1.4.0-incubating".
4. Commit back to the trunk.
svn commit -m "Preparing for release 1.4.0-incubating"
5. Create a branch.
svn copy https://svn.apache.org/repos/asf/incubator/sqoop/trunk \ https://svn.apache.org/repos/asf/incubator/sqoop/branches/branch-1.4.0 \ -m "Branching for 1.4.0 releases"
6. Update the "oldversion" value of build.xml in the trunk to "1.4.0-incubating".
7. Update the "version" value of build.xml in the trunk to "1.4.1-incubating-SNAPSHOT".
8. Commit back to the trunk.
svn commit -m "Preparing for release 1.4.1-incubating development"
9. Tag a candidate, where R (starting from 0) is the iteration number for this candidate:
svn copy https://svn.apache.org/repos/asf/incubator/sqoop/branches/branch-1.4.0 \ https://svn.apache.org/repos/asf/incubator/sqoop/tags/release-1.4.0-rc0 \ -m "Sqoop 1.4.0-rc0 release."
Performing sanity check
1. Check out the candidate.
svn co https://svn.apache.org/repos/asf/incubator/sqoop/tags/release-1.4.0-rc0
2. Generate a tarball.
ant tar
3. Unpack the tarball
tar xvf sqoop-1.4.0-incubating.tar.gz
3. Run tests.
4. Check license header
ant releaseaudit
Sign the Release artifacts
Update KEYS file
If your PGP key is not yet in the project's KEYS file, you need to first add that in. To do this, checkout the KEYS file and update it using the following commands:
$ svn co https://svn.apache.org/repos/asf/incubator/sqoop/dist sqoop-dist ... $ cd sqoop-dist $ (gpg --list-sigs <KEY-ID> && gpg --armor --export <KEY-ID> ) >> KEYS $ svn commit -m "Adding PGP public key to KEYS file" KEYS ...
Once this file has been updated, you need to publish it in the appropriate dist directory for the project on http://www.apache.org/dist/incubator/sqoop/KEYS. To do this, you must copy the file as follows:
$ scp KEYS people.apache.org:/www/www.apache.org/dist/incubator/sqoop/KEYS
This will take some time to propagate in which you can continue with the other steps of the release process.
Create signatures
For every release artifact, there should be a corresponding signature file (*.asc) that can be generated using PGP as follows:
$ gpg --armor --output sqoop-1.4.0-incubating-src.tar.gz.asc --detach-sig sqoop-1.4.0-incubating-src.tar.gz
The above command will generate the new file sqoop-1.4.0-incubating-src.tar.gz.asc which contains the signature that can be verified using the following command:
$ gpg --verify sqoop-1.4.0-incubating-src.tar.gz.asc sqoop-1.4.0-incubating-src.tar.gz
Create md5sum
The md5sum allows a user to ensure that the bits they have downloaded are consistent and same as what were produced during the release. You must create md5sum for every artifact that is being released. Use the following command to generate the md5sum:
$ md5sum sqoop-1.4.0-incubating-src.tar.gz > sqoop-1.4.0-incubating-src.tar.gz.md5sum
Stage the Release Artifacts
In order to allow other developers and contributors to verify the release artifacts, you need to stage them in a place that is accessible to them to download it from. It is preferred if you post these artifacts on your own web-space on people.apache.org. Please make sure that you post all the release artifacts, their signature files (.asc) and their md5sum (.md5sum) files.
Running the vote
Call for dev list votes
Send an email to sqoop-dev@ list. For example,
To: sqoop-dev@incubator.apache.org Subject: [VOTE] Release Sqoop version 1.4.0-incubating This is the first incubator release for Apache Sqoop, version 1.4.0-incubating. *** Please cast your vote by [3 working days after sending] *** The list of fixed issues: http://svn.apache.org/repos/asf/incubator/sqoop/branches/branch-1.4.0/CHANGES.txt The tarball (*.tar.gz), signature (*.asc), checksum (*.md5), license audit result (log/*.ant_releaseaudit.log), and test result (log/*.ant_test.log): http://people.apache.org/~blee/sqoop-1.4.0-incubating-rc0/ The tag to be voted upon: http://svn.apache.org/repos/asf/incubator/sqoop/tags/release-1.4.0-rc0 The KEYS file: http://www.apache.org/dist/incubator/sqoop/KEYS
Need 3 +1 votes from PPMC members.
Call for incubator general list votes
Send an email to incubator-general@ list. For example,
To: general@incubator.apache.org Subject: [VOTE] Release Sqoop version 1.4.0-incubating This is the first incubator release for Apache Sqoop, version 1.4.0-incubating. *** Please cast your vote by [3 working days after sending] *** Dev list vote thread: http://markmail.org/message/jehsoo2vi6xboovu The list of fixed issues: http://svn.apache.org/repos/asf/incubator/sqoop/branches/branch-1.4.0/CHANGES.txt The tarball (*.tar.gz), signature (*.asc), checksum (*.md5), license audit result (log/*.ant_releaseaudit.log), and test result (log/*.ant_test.log): http://people.apache.org/~blee/sqoop-1.4.0-incubating-rc0/ The tag to be voted upon: http://svn.apache.org/repos/asf/incubator/sqoop/tags/release-1.4.0-rc0 The KEYS file: http://www.apache.org/dist/incubator/sqoop/KEYS
Need 3 +1 votes from IPMC members.
Rolling out the Release
Upload the artifacts
ssh people.apache.org cp -r ~/public_html/sqoop-1.4.0-incubating-rc0 /www/www.apache.org/dist/incubator/sqoop/sqoop-1.4.0-incubating cd /www/www.apache.org/dist/incubator/sqoop chgrp -R incubator sqoop-1.4.0-incubating chmod -R g+w sqoop-1.4.0-incubating rm stable ln -s sqoop-1.4.0-incubating stable rm -r /www/www.apache.org/dist/incubator/sqoop/sqoop-$PREVIOUS_VERSION-incubating # remove older versions
Wait for 24 Hours
It may take up to 24 hours for all mirrors to sync up.
Announce the release
Send an email to announce@apache.org (the from: address must be @apache.org). For example,
To: announce@apache.org, sqoop-user@incubator.apache.org, sqoop-dev@incubator.apache.org Subject: [ANNOUNCE] Apache Sqoop 1.4.0-incubating released The Apache Sqoop team is pleased to announce the release of Sqoop 1.4.0-incubating from the Apache Incubator. This is the first incubator release of Apache Sqoop, a tool designed for efficiently transferring bulk data between Apache Hadoop and structured datastores, such as relational databases. The release is available here: http://www.apache.org/dyn/closer.cgi/incubator/sqoop/ The full change log is available here: https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311320&version=12317345 Your help and feedback is more than welcome. For more information on how to report problems and to get involved, visit the project website at http://incubator.apache.org/sqoop/. The Apache Sqoop Team