For general information on ASF releases, see: http://www.apache.org/dev/release.html
If this is a minor release (X.Y.0), start with creating a new branch. Example for 3.4.0:
git checkout master && git pull git checkout -b release-3.4 master
Replace version in master branch:
git checkout master git grep -l "3.4.0-SNAPSHOT"
For informational purpose, this should yield the list of files that needs the version number replaced to X.(Y+1).0 next version. Note that the replacement step is different between the repositories due to an open issue. See:
https://issues.apache.org/jira/browse/APEXCORE-34
For -core:
dv=3.4.0-SNAPSHOT rv=3.5.0-SNAPSHOT for a in `git grep -l "${dv}"`; do echo $a; sed -i 's/'"${dv}"'/'"${rv}"'/g' $a; done
For -malhar:
mvn versions:set -DnewVersion=${rv} -Pall-modules
Commit and push the change:
git commit -am "Preparing for 3.5.0 development" git push apache master
For Java classes added since the last release, the @since tags need to be added. The javadoc plugin inserts missing tags, but does not play well with the license header when no class level documentation block is present. This is tracked as
https://issues.apache.org/jira/browse/APEXCORE-183
It also removes the custom @tags doclet tag when the existing JavaDoc is malformed, do not use this to make changes in Malhar. Until these problems are resolved, use the following Ruby script to do the replacement: https://issues.apache.org/jira/secure/attachment/12781158/add-since.rb
ruby ~/add-since.rb `pwd` -s 3.4.0
Navigate to the unreleased version, example:
https://issues.apache.org/jira/browse/APEXMALHAR/fixforversion/12334589
Obtain the release notes (text mode):
Shorten any wrapping and overly long titles to fit width. Copy the report and insert new release section into CHANGELOG.md with the release date set to 72 hours ahead to reflect the time for the vote.
Create shortlink for the JIRA release notes on http://s.apache.org/ for use in the VOTE thread. Example: http://s.apache.org/8uT
Commit tags and change log:
git commit -am "Add @since tags and update change log for release 3.4.0"
dv=3.4.0-SNAPSHOT rv=3.4.0
As mentioned earlier, use the following for -core releases:
for a in `git grep -l "${dv}"`; do echo $a; sed -i 's/'"${dv}"'/'"${rv}"'/g' $a; done
And this for -malhar releases:
mvn versions:set -Pall-modules -DnewVersion=${rv}
Commit version change:
git commit -am "Preparing to release ${rv}-RC1"
git tag -a "v${rv}-RC1" -m "Release ${rv}-RC1"
Push to fork (as temporary branch), open pull request, wait for Travis CI build to succeed. Then push the tag.
git push apache "v${rv}-RC1"
The only difference between release branch and tag is this final version number change. The branch stays at -SNAPSHOT version.
Prerequisites:
apache.staging.https server distribution management in ~/.m2/settings.xmlBuild and deploy release candidate from RC tag:
git checkout "v${rv}-RC1"
git clean -d -f
mvn clean apache-rat:check deploy -Papache-release -Pall-modules -DskipTests
Confirm no archives are included in source release (rat:check reports them in target/rat.txt but does not fail the build):
unzip -l target/*-source-release.zip | grep -e ".zip\|.jar"
Log on to https://repository.apache.org and look for Staging Repositories. “Close” the newly created orgapacheapex-xxxx staging repository to obtain the temporary URL, note it down for the VOTE thread.
Example URL: https://repository.apache.org/content/repositories/orgapacheapex-1000/
Copy files to distribution dir and create signatures and checksums. (Note this is per policy to stage these files outside of the Maven repository, otherwise everything below would happen automatically as defined in the parent POM.)
For -core releases:
RNAME=apache-apex-core-${rv}
For -malhar releases:
RNAME=apache-apex-malhar-${rv}
cd target md5sum ${RNAME}-source-release.tar.gz > ${RNAME}-source-release.tar.gz.md5 md5sum ${RNAME}-source-release.zip > ${RNAME}-source-release.zip.md5 shasum -a 512 ${RNAME}-source-release.tar.gz > ${RNAME}-source-release.tar.gz.sha shasum -a 512 ${RNAME}-source-release.zip > ${RNAME}-source-release.zip.sha gpg --yes --armor --output ${RNAME}-source-release.tar.gz.asc --detach-sig ${RNAME}-source-release.tar.gz gpg --yes --armor --output ${RNAME}-source-release.zip.asc --detach-sig ${RNAME}-source-release.zip
Check files into the dist staging area:
mkdir svn-dist && cp *-source-* svn-dist/ svn import svn-dist https://dist.apache.org/repos/dist/dev/apex/${RNAME}-RC1 -m "Apache Apex v${rv}-RC1"
Vote call sample: http://mail-archives.apache.org/mod_mbox/apex-dev/201605.mbox/%3CCAKJfLDPr3CBCfstQJWjchG-ZEYw5P%2Bwv5jN0tfy3EL%2BU%3DBUQgQ%40mail.gmail.com%3E
If the vote is not successful, a new RC needs to be built and new vote called. Once the PMC vote passes, proceed with promoting and announcing the release.
Release Nexus staging repository: http://central.sonatype.org/pages/releasing-the-deployment.html#close-and-drop-or-release-your-staging-repository
Move source release from dist staging to release folder:
rv=3.4.0
RNAME=apache-apex-core-${rv}
svn mv https://dist.apache.org/repos/dist/dev/apex/${RNAME}-RC1 https://dist.apache.org/repos/dist/release/apex/${RNAME} -m "Release ${RNAME}"
Close release and all associated tickets (use bulk change workflow transition and turn off notification at bottom of page). Create version number X.Y.Z+1 for next release
Create final release tag:
rv=3.4.0 git tag -a "v${rv}" -m "Release ${rv}" "v${rv}-RC2" git push apache "v${rv}"
Bump patch version number in release branch (X.Y.Z+1 - otherwise same as when creating new release branch):
git checkout release-3.4 dv=3.4.0-SNAPSHOT rv=3.4.1-SNAPSHOT for a in `git grep -l "${dv}"`; do echo $a; sed -i 's/'"${dv}"'/'"${rv}"'/g' $a; done
If there are new artifacts published to Maven repositories consider enabling semantic versioning check for the newly published libraries.
Commit all changes and push them to the remote git repository:
git commit -am "Preparing for 3.4.1 development" git push apache
Merge @since tag and change log changes to master.
For minor or major release, publish the documentation to the web site prior to updating download page (which will automatically link the documentation). See https://github.com/apache/apex-core/tree/master/docs#deployment
Update the download page to reflect the new release: https://github.com/apache/apex-site#updating-downloads-page
Send the announcement email, example: http://mail-archives.apache.org/mod_mbox/www-announce/201605.mbox/%3CCA%2B5xAo1ZYso6azUBJOkpVtJqM%3DAnJFr_RtjKk9_VusBwgYNS8A%40mail.gmail.com%3E
As part of publishing new releases, please determine whether old releases should be deleted. See release archiving policy for details why.
With a new patch release, the previous patch release can be removed. For example, once 3.4.1 patch is released, we no longer need to have 3.4.0 on the download page.
Once a release branch is no longer supported, we can also remove the last release in that line. For example once release-3.4 branch is EOL, releases 3.4.1 (or whatever the latest patch was) can be removed from downloads.