This document describes how to make a release of Sqoop 2 from git branch "sqoop2". 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.99.1, and the following development version will become 1.99.2
- Creating Release Artifacts
- Running the vote
- Rolling out the Release
- Publish binary artifacts in Maven Repository
Frequently asked questions for making Apache releases are available on Releases FAQ page.
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.
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:
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.99.1'.
You can also run the following query to make sure that the issues fixed for the to-be-released version look accurate:
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
Create a release branch
Creating branches in git is easy, simple, cheap, fast and race condition less with comparison to SVN. There is no need explicitly announce that you're going to create release branch and ask everyone to stop committing.
1. Clone fresh repository copy
2. Checkout Sqoop 2 branch
3. Check that current HEAD points to commit on which you want to base new release branch. Checkout particular commit if not.
4. Create new release branch with name "branch-$version"
5. Push new branch to Apache repository
6. Check that branch was correctly propagated to Apache repository. You should be able to see your branch on following git webui.
7. Update version to your release version in all pom.xml files (.pom.xml, */pom.xml and *//pom.xml). You should be changing the version only in <parent> tag (with exception of root pom.xml file that obviously do not have a parent).
simple trick to get all the pom.xmls changed
8. Check your changes by running package build
9. Commit your changes and push them to Apache repository
10. Send an email announcing new branch
Subject: New release branch 1.99.1
I've just created new release branch for upcoming 1.99.1 release. Please continue committing to main Sqoop 2 branch "sqoop2" as usual, I'll cherry-pick commits to branch-1.99.1 on per needed basis.
Update change log file
1. It's important to update changelog file with all changes that went it to the release. JIRA is generating list of all changes in particular release in "Release notes" section:
- On main page click "versions" from left menu
- Click on your version
- There is link "Release notes" on top left corner of the context area.
2. You can use ruby script jira2changelog.rb attached to this page to transform this page into desired output.
3. Update CHANGELOG.txt file in branches sqoop2 and branch-<your-version>.
4. It's important to keep this file up-to-date with each committed change after initial branch cut.
Create release tarballs
1. Check out release branch
2. Make sure that LICENSE.txt contains license information for all third-party libraries. In order to do this check properly, you will need to quickly create all packages. You need to check jars available in client/lib, server/lib and insider sqoop server war file (server/webapps/sqoop.war).
2. Create tag on this commit to identify precise point where the RC was generated and push this tag to main repository
3. Create temporary directory where you'll be preparing all required artifacts
4. Create source artifact and move it to your temporary directory
5. Create binary artifact for each supported hadoop version and move generated artifacts to your temporary directory
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:
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/sqoop/KEYS. To do this, you must copy the file as follows:
This will take some time to propagate in which you can continue with the other steps of the release process.
Create signatures and check sums
1. Change your working directory to the temporal one
2. Sing each file with your key
3. You can immediately verify your signature
4. Create md5 check sum
5. Create sha1 check sum
6. Upload artifacts and all created check sums with signatures to your own web-space on people.apache.org
Running the vote
Call for sqoop dev list votes
Send an email to dev@ list. For example,
Need 3 +1 votes from PMC members.
You can close the vote after voting period expires when you accumulate sufficient votes. Example close email:
After closing the vote, you need to send results. Example email:
Rolling out the Release
Close JIRA version
You need to close the release in JIRA so that everyone knows that your version should not be used as "fixVersion" for new bugs. Go to JIRA "Administer project" page and follow "Versions" in left menu. Table with list of all releases should appear, click on additional menu on the right of your release and choose "Release" option. Submit release date and you're done.
Upload the artifacts
Sqoop is using SVN based release procedure. In order to release you have to checkout release repository located on https://dist.apache.org/repos/dist/release/sqoop and add release artifacts there.
Wait for 24 Hours
It may take up to 24 hours for all mirrors to sync up.
Remove old releases from dist area
Don't worry, they will be archived on archive.apache.org. We need to release the pressure on all Apache mirrors so only most recent releases are allowed to be in the distribution area.
You need to update Sqoop webpages to reflect new release. Instructions are on separate wiki page.
Announce the release
Send an email to firstname.lastname@example.org (the from: address must be @apache.org). For example,
Publish binary artifacts in Maven Repository
1. Configure your Apache credentials in your maven settings.xml file (usually in ~/.m2/settings.xml). More information is available in official guide.
2. Go to release branch (tag that was released)
3. Create, sign and deploy artifacts into staging repository
4. Login to https://repository.apache.org and select "Staging Repositories" under "Build Promotion" menu on the left.
5. Select org.apache.sqoop from the list of repositories and click "Close" using "Apache Sqoop 1.99.1" as description.
6. Select org.apache.sqoop from the list of repositories and click "Release" using "Apache Sqoop 1.99.1 artifacts" as description