You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

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

Only do this for major (X.0.0) and minor(X.Y.0) releases but not for patches (X.Y.Z).

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.

  • Include release version and date (use Unreleased for the date if it is unknown).
  • For example,
Apache Sqoop Change Log

Release X.Y.0 - Unreleased

  NEW FEATURES

    SQOOP-305 Support export from Avro Data Files

    ...

3. Update the "version" value of build.xml in trunk to "X.Y.0-incubating".

4. Commit back to the trunk.

svn commit -m "Preparing for release X.Y.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-X.Y.0 \
  -m "Branching for X.Y.0 releases"

6. Update the "oldversion" value of build.xml in the trunk to "X.Y.0-incubating".

7. Update the "version" value of build.xml in the trunk to "X.Y+1.0-incubating-SNAPSHOT".

8. Commit back to the trunk.

svn commit -m "Preparing for release X.Y+1.0-incubating development"

9. Tag a candidate, where R is the iteration number for this candidate:

svn copy https://svn.apache.org/repos/asf/incubator/sqoop/branches/branch-X.Y.0 \
  https://svn.apache.org/repos/asf/incubator/sqoop/tags/release-X.Y.0-rcR \
  -m "Sqoop X.Y.0-rcR release."

Performing sanity check

1. Check out the candidate.

svn co https://svn.apache.org/repos/asf/incubator/sqoop/tags/release-X.Y.0-rcR

2. Generate a tarball.

ant tar

3. Unpack the tarball

tar xvf sqoop-X.Y.0-incubating.tar.gz

3. Run tests.

4. Check license header

ant releaseaudit

Running the vote

Call for PPMC votes

Send an email to sqoop-dev@ list. For example,

To: sqoop-dev@incubator.apache.org
Subject: [VOTE] Release Sqoop version X.Y.Z-incubating

This is to call for vote to release Apache Sqoop, version X.Y.Z-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-X.Y.0/CHANGES.txt

The tarball (.tar.gz), signature (.asc), checksum (.md5), license audit result (ant_releaseaudit.log), and test result (ant_test.log):
http://people.apache.org/~blee/sqoop-X.Y.0-incubating-rcR/

The tag to be voted upon:
http://svn.apache.org/repos/asf/incubator/sqoop/tags/release-X.Y.0-rcR

The KEYS file:
http://www.apache.org/dist/incubator/sqoop/KEYS

Call for IPMC votes

Send an email to sqoop-dev@ list. For example,

To: sqoop-dev@incubator.apache.org
Subject: [VOTE] Release Sqoop version X.Y.Z-incubating

This is to call for vote to release Apache Sqoop, version X.Y.Z-incubating.

*** Please cast your vote by [3 working days after sending] ***

PPMC release vote thread:

The list of fixed issues:
http://svn.apache.org/repos/asf/incubator/sqoop/branches/branch-X.Y.0/CHANGES.txt

The tarball (.tar.gz), signature (.asc), checksum (.md5), license audit result (ant_releaseaudit.log), and test result (ant_test.log):
http://people.apache.org/~blee/sqoop-X.Y.0-incubating-rcR/

The tag to be voted upon:
http://svn.apache.org/repos/asf/incubator/sqoop/tags/release-X.Y.0-rcR

The KEYS file:
http://www.apache.org/dist/incubator/sqoop/KEYS

Rolling out the Release

Upload the artifacts

ssh people.apache.org
cp -r ~/public_html/sqoop-X.Y.0-incubating-rcR /www/www.apache.org/dist/incubator/sqoop/sqoop-X.Y.0-incubating
cd /www/www.apache.org/dist/incubator/sqoop
chgrp -R incubator sqoop-X.Y.0-incubating
chmod -R g+w sqoop-X.Y.0-incubating
rm stable
ln -s sqoop-X.Y.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 X.Y.0-incubating released

The Apache Sqoop team is pleased to announce the release of Sqoop
X.Y.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
various 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

We welcome your help and feedback. 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
  • No labels