...
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.1.0.
Table of Contents |
---|
Prerequisites
Policy documents
...
2. Since the JIRA release note tool will list all JIRAs associated with a particular fixVersion regardless of their Resolution, you may want to remove fixVersion on issues declared as "Duplicate", "Won't Fix", "Works As Expected", etc. You can use this query to find those issues, then just bulk edit them and leave the fixVersion field blank when editing them. (Note that you will need to replace "v1.4.0" below with the version you are trying to release.)
JIRA: project = Flume AND (Status != Resolved AND OR Resolution != Fixed) AND fixVersion = " v1.46.0"
3. Finally, check out the output of the JIRA release note tool to see which JIRAs are included in the release, in order to do a sanity check.
...
1. Checkout the trunk.
No Format |
---|
git clone http://git-wip-us.apache.org/repos/asf/flume.git flume
|
...
3. Update the "version" value of all pom.xml and RELEASE-NOTES in trunk to X.(Y+1).0:
No Format |
---|
git checkout trunk
find . -name pom.xml | xargs sed -i "" -e "s/X.Y.0-SNAPSHOT/X.$(Y+1).0-SNAPSHOT/"
find flume-ng-doc/ -name "*.rst" | xargs sed -i "" -e "s/X.Y.0-SNAPSHOT/X.$(Y+1).0-SNAPSHOT/"
vim RELEASE-NOTES
git add .
git commit -m "FLUME-XXXX: Preparing for the X.Y release"
|
4. Find hash for use later
No Format |
---|
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
No Format |
---|
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
No Format |
---|
git push -u origin trunk:trunk
git push -u origin flume-X.Y:flume-X.Y
|
7. Checkout the release branch:
No Format |
---|
git checkout flume-X.Y
|
8. Remove -SNAPSHOT from the release branch and commit
No Format |
---|
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"
|
...
10. Tag a candidate:
No Format |
---|
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:
No Format |
---|
git tag -d release-X.Y.Z
git push origin :refs/tags/release-X.Y.Z
|
...
1. Check out the candidate
No Format |
---|
git checkout release-X.Y.Z
|
2. Generate a tarball
No Format |
---|
mvn clean install -DskipTests
|
3. Unpack the source tarball
No Format |
---|
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
No Format |
---|
cd apache-flume-X.Y.Z-src
mvn clean install -Psite
|
...
1. Add your key to the KEYS file:
No Format |
---|
(gpg --list-sigs <your-email> && gpg --armor --export <your-email>) >> KEYS
|
...
From the flume root directory
No Format |
---|
mvn clean deploy -Psite -Psign -DskipTests
|
...
Do the same for javadoc and source artifacts:
No Format |
---|
mvn javadoc:jar gpg:sign deploy:deploy
mvn source:jar gpg:sign deploy:deploy
|
...
Copy the apache-flume-X.Y.Z-{bin,src}.tar.gz{,.{asc,md5,sha1}} files to people.apache.org.
No Format |
---|
$ ssh people.apache.org
$ cd public_html
$ mkdir apache-flume-X.Y.Z-rcN
$ cd apache-flume-X.Y.Z-rcN
$ wget --no-check-certificate https://repository.apache.org/content/repositories/orgapacheflume-XXXX/org/apache/flume/flume-ng-dist/X.Y.Z/flume-ng-dist-X.Y.Z-{src,bin}.tar.gz{,.{asc,md5,sha1}}
$ for file in flume-ng-dist-*; do mv $file $(echo $file | sed -e "s/flume-ng-dist/apache-flume/g");done
|
...
Send an email to dev@flume.apache.org list. For example,
No Format |
---|
To: dev@flume.apache.org
Subject: [VOTE] Release Apache Flume version X.Y.Z RC1
This is the XXXXX release for Apache Flume as a top-level project,
version X.Y.Z. We are voting on release candidate RC1.
It fixes the following issues:
<Link-to-CHANGELOG-in-the-tag>
*** Please cast your vote within the next 72 hours ***
The tarball (*.tar.gz), signature (*.asc), and checksums (*.md5, *.sha1)
for the source and binary artifacts can be found here:
https://people.apache.org/~mpercy/flume/apache-flume-X.Y.Z-RC1/
Maven staging repo:
https://repository.apache.org/content/repositories/orgapacheflume-XXXXX/
The tag to be voted on:
https://git-wip-us.apache.org/repos/asf?p=flume.git;a=commit;h=<commit-hash-of-the-tag>
Flume's KEYS file containing PGP keys we use to sign the release:
https://svn.apache.org/repos/asf/flume/dist/KEYS
|
...
Source and convenience artifacts
No Format |
---|
svn checkout https://dist.apache.org/repos/dist/release/flume dist-flume
cd dist-flume
mkdir 1.0.0
cp <all release artifacts including asc/checksum files> 1.0.0/
svn rm stable # remove older version link
ln -s 1.0.0 stable # update stable version link
svn add stable 1.0.0
svn commit
|
...
Send an email to announce@apache.org (the from: address must be @apache.org). For example,
No Format |
---|
To: announce@apache.org, user@flume.apache.org, dev@flume.apache.org
Subject: [ANNOUNCE] Apache Flume 1.2.0 released
The Apache Flume team is pleased to announce the release of Flume
version 1.2.0.
Flume is a distributed, reliable, and available service for efficiently
collecting, aggregating, and moving large amounts of log data.
This release can be downloaded from the Flume download page at:
http://flume.apache.org/download.html
The change log and documentation are available on the 1.2.0 release page:
http://flume.apache.org/releases/1.2.0.html
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://flume.apache.org/
The Apache Flume Team
|
...