Page History

...

The change list can be swiped from the JIRA release note tool (use choose the "text" format for the change log). See JIRA Cleanup above to ensure that the release notes generated by this tool are what you are expecting. Additionally, in the last two releases we have re-ordered the issues to be New Features, Improvements, Bugs, etc as by default the least important items are at the top.

3. Update the "version" value of all pom.xml and in RELEASE-NOTES in trunk to X.(Y+1).0:

vim RELEASE-NOTES
git checkoutadd trunk
find . -name pom.xml | xargs sed -i "" -e "s/X.Y.0-SNAPSHOT/X.$RELEASE-NOTES
git commit RELEASE-NOTES -m "Updating Flume version in RELEASE-NOTES for release X.Y.Z"

4. Create a branch for the X.(Y+1)

...

release series

E.g. flume-1.5 should be branched off of trunk

git checkout trunk
git checkout -b flume-X.(Y+1)

4. Update the "version" value of all pom.xml and documentation files in trunk to X.(Y+1).0-SNAPSHOT

/"
vim RELEASE-NOTES
git addcheckout .trunk
gitmvn commit -m "FLUME-XXXX: Preparing for the X.Y release"

4. Find hash for use later

git log

5. Create a branch for the X.(Y+1) release series

E.g. flume-1.5 should be branched off of flume-1.4

git checkout flume-X.Y
git checkout -b flume-X.(Y+1)
git cherry-pick <hash from the previous step>

6. Push the changes up stream

git push -u origin trunk:trunk
git push -u origin flume-X.Y:flume-X.Y

7. Checkout the release branch:

git checkout flume-X.Y

8. Remove -SNAPSHOT from the release branch and commit

find . -name pom.xml | xargs sed -i "" -e "s/X.Y.0-SNAPSHOT/X.Y.0/"
find flume-ng-doc/ -name "*.rst" | xargs  sed -i "" -e "s/X.Y.0-SNAPSHOT/X.Y.0/"
git add .
git commit -m "FLUME-XXXX: Removing -SNAPSHOT from X.Y branch"

9. Ensure RELEASE-NOTES has the appropriate version and description of the release.

10. Tag a candidate:

git tag -a release-X.Y.Z -m "Apache Flume X.Y.Z release."
git push origin release-X.Y.Z

If an rc1, rc2, etc is needed, delete that tag before creating a new one:

git tag -d release-X.Y.Z
git push origin :refs/tags/release-X.Y.Z

Performing sanity check

1. Check out the candidate

git checkout release-X.Y.Z

2. Generate a tarball

mvn clean install -DskipTests

3. Unpack the source tarball

cd flume-ng-dist/target
rm -rf ./apache-flume-X.Y.Z-src/
tar xzvf apache-flume-X.Y.Z-src.tar.gz

4. Do another full build inside the source tarball. This time, allow all unit tests & integration tests to run and also include the docs

cd apache-flume-X.Y.Z-src
export LC_ALL=C.UTF-8 # Required to build the javadocs on some platforms and in some locales
mvn clean install -Psite -DskipTests

5. Verify that the HTML docs that should have been generated inside the binary artifact under /docs are there and do not have rendering errors.

Signatures and Checksums

All artifacts must be signed and checksummed. In order to sign a release you will need a PGP key. You should get your key signed by a few other people. You will also need to recv their keys from a public key server. See the Apache release signing page for more details.

1. Add your key to the KEYS file:

(gpg --list-sigs <your-email> && gpg --armor --export <your-email>) >> KEYS

And commit the changes.

2. Create and sign the artifacts, including site docs

versions:set -DnewVersion=X.Y.(Z+1)-SNAPSHOT -DgenerateBackupPoms=false
cd build-support
mvn versions:set -DnewVersion=X.Y.(Z+1)-SNAPSHOT -DgenerateBackupPoms=false
cd ..
git add .
git commit -m "Updating trunk version to X.$(Y+1).0-SNAPSHOT for Flume X.Y.Z release"

5. Checkout the release branch and remove -SNAPSHOT from the release branch poms and docs and commit:

git checkout flume-X.Y
mvn versions:set -DnewVersion=X.Y.(Z+1)-SNAPSHOT -DgenerateBackupPoms=false
cd build-support
mvn versions:set -DnewVersion=X.Y.(Z+1)-SNAPSHOT -DgenerateBackupPoms=false
cd .. git add .
git commit -m "FLUME-XXXX: Removing -SNAPSHOT from X.Y branch"

6. Ensure RELEASE-NOTES has the appropriate version and description of the release.

7. Push the branching changes upstream

git push -u origin trunk:trunk
git push -u origin flume-X.Y:flume-X.Y

8. Tag a release candidate (in the example below, RC1):

git tag -a release-X.Y.Z-rc1 -m "Apache Flume X.Y.Z RC1"
git push origin release-X.Y.Z-rc1

If an rc2, rc3 etc is needed, simply create a new rc tag:

git tag -d release-X.Y.Z-rc2
git push origin release-X.Y.Z-rc2

Performing sanity check

1. Check out the candidate tag

git checkout release-X.Y.Z-rc1

2. Generate a tarball

mvn clean install -DskipTests

3. Unpack the source tarball

cd flume-ng-dist/target
rm -rf ./apache-flume-X.Y.Z-src/
tar xzvf apache-flume-X.Y.Z-src.tar.gz

4. Do another full build inside the source tarball. This time, allow all unit tests & integration tests to run and also include the docs

cd apache-flume-X.Y.Z-src
export LC_ALL=C.UTF-8 # Required to build the javadocs on some platforms and in some locales
mvn clean install -Psite -DskipTests

5. Verify that the HTML docs that should have been generated inside the binary artifact under /docs are there and do not have rendering errors.

Signatures and Checksums

All artifacts must be signed and checksummed. In order to sign a release you will need a PGP key. You should get your key signed by a few other people. You will also need to recv their keys from a public key server. See the Apache release signing page for more details.

1. Add your key to the KEYS file:

(gpg --list-sigs <your-email> && gpg --armor --export <your-email>) >> KEYS

And commit the changes.

2. Create and sign the artifacts, including site docs. This pushes the signed artifacts to the ASF staging repository.

In order to do this, you will need a settings.xml file with your username and password for the ASF staging repository. Typically this is placed in ~/.m2/settings.xml and might look something like this:

<settings>
  <servers>
    <server>
      <id>apache.releases.https</id>
      <username>your_user_id</username>
      <password>your_password</password>
    </server>
  </servers>
</settings>

Once your settings.xml file is correct, you run the following from the flume root directory to generate and deploy the artifacts:From the flume root directory

mvn clean deploy -Psite -Psign -DskipTests

...

Select org.apache.flume from the list of repositories, verify it looks OK, and then click Close using "Apache Flume X.Y.Z" as the description to allow others to see the repository. Note that the staging repository will have a numeric id associated with it that will be used later

4. Copy artifacts to people.apache.orgthe distribution directories

Copy the apache-flume-X.Y.Z-{bin,src}.tar.gz{,.{asc,md5,sha1sha512}} files to people.apache.org.

...

the distribution directory.

1. Copy the distribution archive files from flume-ng-dist/target to where https://dist.apache.org/repos/dist/dev/flume is checked out on your machine. 

2. Use "svn delete" to remove any files from prior releases in the directory.
3. Use "svn commit" to update the new files.

Update the staging website

1. Clone https://github.com/apache/flume-site.
2. Checkout the asf-staging branch.
3. Add a page to the source/sphinx/releases directory for the new release, with the Changelog and links to the documentation (refer previous release pages for details. The documentation should simply use the same paths as the previous releases with correct versions - the documentation will be checked in directly to the production website as mentioned below).

   1. edit the new release page using a regex. The search string should be 

      Code Block
      ^(.*)\[FLUME\-(\d+)\](.*)$

      and the replacement string should be
      
      

      Code Block
      $1\[`FLUME-$2 <https://issues.apache.org/jira/browse/FLUME-$2>`__\]$3

      
      

4. Update content/sphinx/releases/index.rst to update the pointer to the latest release.
5. Update content/sphinx/download.rst to also point to the latest release.
6. Update content/sphinx/index.rst as necessary to add a News item to the home page.
7. Copy the release version of the FlumeUserGuide.rst and FlumeDeveloperGuide.rst to the Documentation directory.
8. Commit the changes and push them.

9. Run mvn package and verify the site at target/site/index.html.

10. Run mvn pre-site install.
11. Verify the site at https://flume.staged.apache.org.

...

Running the vote

Call for dev list votes

...

svn checkout https://dist.apache.org/repos/dist/release/flume dist-flume
cd dist-flume
mkdir 1{x.0y.0z}
cp <all release artifacts including asc/checksum files> 1{x.0y.0z}/
svn rm stable{x.?.?} # remove older version link
ln -s 1.0.0 stable # update stable version link
svn add stable 1.0.0
svn commitprior release(s)
svn commit -m "Release Flume {x.y.z}"

It may take up to 24 hours for all mirrors to sync up.

...