THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
This document describes how to make a release of Flume. 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.0.0, and the following development version will become 1.0.1.
| Table of Contents |
|---|
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:
| No Format |
|---|
project = flume 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.0.0'.
You can also run the following query to make sure that the issues fixed for the to-be-released version look accurate:
| No Format |
|---|
project = flume and resolution = fixed and fixVersion = '1.0.0'
|
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 flume-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.
| Code Block |
|---|
svn co https://svn.apache.org/repos/asf/incubator/flume/trunk
|
2. Update CHANGES.txt in the trunk.
For example,
Apache flume Change Log
| No Format |
|---|
Release 1.0.0
NEW FEATURES
FLUME-760 FLUME-728 Implement JDBC based channel implementation
...
|
3. Update the "version" value of all pom.xml in trunk to "1.0.0".
4. Commit back to the trunk.
| Code Block |
|---|
svn commit -m "Preparing for release 1.0.0"
|
5. Create a branch.
| Code Block |
|---|
svn copy https://svn.apache.org/repos/asf/incubator/flume/trunk \
https://svn.apache.org/repos/asf/incubator/flume/branches/branch-1.0.0 \
-m "Branching for 1.0.0 releases"
|
6. Update the "oldversion" value of all pom.xml in the trunk to "1.0.0".
7. Update the "version" value of all pom.xml in the trunk to "1.0.1-SNAPSHOT".
8. Commit back to the trunk.
| Code Block |
|---|
svn commit -m "Preparing for release 1.0.1 development"
|
9. Tag a candidate, where R (starting from 0) is the iteration number for this candidate:
| Code Block |
|---|
svn copy https://svn.apache.org/repos/asf/incubator/flume/branches/branch-1.0.0 \
https://svn.apache.org/repos/asf/incubator/flume/tags/release-1.0.0-rc0 \
-m "flume 1.0.0-rc0 release."
|
Performing sanity check
1. Check out the candidate.
| Code Block |
|---|
svn co https://svn.apache.org/repos/asf/incubator/flume/tags/release-1.0.0-rc0
|
2. Generate a tarball.
| Code Block |
|---|
mvn -DskipTests package
|
3. Unpack the tarball
| Code Block |
|---|
tar xvf flume-1.0.0.tar.gz
|
3. Run tests.
| Code Block |
|---|
mvn test
|
4. Check license header
| Code Block |
|---|
mvn verify
|
Running the vote
Call for dev list votes
Send an email to flume-dev@ list. For example,
| No Format |
|---|
To: flume-dev@incubator.apache.org
Subject: VOTE Release flume version 1.0.0
This is the first incubator release for Apache flume, version 1.0.0.
Please cast your vote by *** 3 working days after sending ***
The list of fixed issues:http://svn.apache.org/repos/asf/incubator/flume/branches/branch-1.0.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/~prasadm/flume-1.0.0-rc0/
The tag to be voted upon:http://svn.apache.org/repos/asf/incubator/flume/tags/release-1.0.0-rc0
The KEYS http://www.apache.org/dist/incubator/flume/KEYS"
|
Need 3 +1 votes from PPMC members.
Call for incubator general list votes
Send an email to incubator-general@ list. For example,
| No Format |
|---|
To: general@incubator.apache.org
Subject: VOTE Release flume version 1.0.0
This is the first incubator release for Apache flume, version 1.0.0.
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/flume/branches/branch-1.0.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/~prasadm/flume-1.0.0-rc0/
The tag to be voted upon:http://svn.apache.org/repos/asf/incubator/flume/tags/release-1.0.0-rc0
The KEYS http://www.apache.org/dist/incubator/flume/KEYS"
|
Need 3 +1 votes from IPMC members.
Rolling out the Release
Upload the artifacts
| Code Block |
|---|
ssh people.apache.org
cp -r ~/public_html/flume-1.0.0-rc0 /www/www.apache.org/dist/incubator/flume/flume-1.0.0
cd /www/www.apache.org/dist/incubator/flume
chgrp -R incubator flume-1.0.0
chmod -R g+w flume-1.0.0
rm stable
ln -s flume-1.0.0 stable
rm r /www/www.apache.org/dist/incubator/flume/flume$PREVIOUS_VERSION # remove older versions
|
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,
| No Format |
|---|
To: announce@apache.org, flume-user@incubator.apache.org, flume-dev@incubator.apache.org
Subject: ANNOUNCE Apache flume 1.0.0 released
The Apache flume team is pleased to announce the release of flume 1.0.0
from the Apache Incubator.
This is the first incubator release of Apache flume, 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/flume/
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/flume/.
The Apache flume Team
|
Requirements:
...