Author: nbubna
Date: Tue Feb 3 19:30:15 2009
New Revision: 740385
URL: http://svn.apache.org/viewvc?rev=740385&view=rev
Log:
more release instruction updates
Modified:
velocity/tools/trunk/build.xml
Modified: velocity/tools/trunk/build.xml
URL:
http://svn.apache.org/viewvc/velocity/tools/trunk/build.xml?rev=740385&r1=740384&r2=740385&view=diff
==============================================================================
--- velocity/tools/trunk/build.xml (original)
+++ velocity/tools/trunk/build.xml Tue Feb 3 19:30:15 2009
@@ -483,10 +483,38 @@
<!-- Convenient target for rolling releases -->
<target name="release"
- depends="release.source,release.binaries,env"
- description="Creates binary and source distribution files">
+ depends="release.source,release.binaries,env,release.howto"
+ description="Creates binary and source distribution files"/>
+
+ <target name="release.howto">
<echo>
- ***** RELEASE INSTRUCTIONS *****
+ ***** RELEASE INSTRUCTIONS *****
+
+ * Be sure you can answer "yes" to the following:
+
+ * Was your local code up to date and free of modifications or extra
files?
+
+ * Was the version number correct in both build.properties and pom.xml?
+
+ * For a final release, the distributionManagement.site.url value
+ in the pom.xml should be:
+
scpexe://people.apache.org/www/velocity.apache.org/engine/releases/velocity-${version}
+ and for alpha or beta releases it should be:
+ scpexe://people.apache.org/www/velocity.apache.org/engine/devel/
+
+ * Do all new files have the Apache License? (use "ant rat" to
double-check)
+
+ * Is ${build.src}/changes/changes.xml up to date?
+ Feel free to set an estimated release date for this version in that
file;
+ it can be corrected later if the release is delayed.
+
+ * Is ${build.src}/site/apt/upgrading.apt up to date for this release?
+
+ * Is the ${velocity.dir}/README.txt up to date for this release?
+
+ * If a final release, update the "Where do I get releases?" section of
+ ${build.dir}/xdocs/docs/index.xml
+ to show the latest stable version number.
* Check that you have no uncommitted changes with 'svn status'
@@ -497,17 +525,29 @@
* Check that all version numbers are in sync: build.properties,
changes.xml, and pom.xml
* Check that the README.txt and other documentation are up to date.
+
+ * Write down the current svn revision so you don't have to look it up
+ later when you make the tag for this release (post-vote).
+ * Go to ${build.dir} and sign all the jar, zip, tar.gz and pom files
+ with your personal PGP key. If using gpg, you'll probably do this:
+ gpg --armor --output ${final.name}.zip.asc --detach-sig
${final.name}.zip
* Now that the distribution files have been created, you will need to sign
all
- of the jar, zip, and tar.gz files with your private key. You can
simplify
+ of the jar, zip, pom, and tar.gz files with your private key. You can
simplify
this process with a script along the lines of:
#! /bin/bash
for i in *.tar.gz *.zip *jar; do
- gpg --default-key [your key id here] --armor --output $i.asc
--detach-sig $i
+ gpg --armor --output $i.asc --detach-sig $i
done
+ * SSH into people.apache.org and make sure that this directory exists:
+ ${publish.dir}
* Login to people.apache.org and create an empty folder at:
~/public_html/velocity/tools/${project.version}
+
+ * If you haven't done it before, ensure that your PGP key is appended to
+ /www/www.apache.org/dist/velocity/KEYS
+ Some instructions for that are at the top of that file.
* Use 'ant publish' to upload the distribution files to that folder.
@@ -679,8 +719,8 @@
</condition>
</target>
- <target name="publish" depends="prepare.publish" if="ready"
- description="Uploads distribution files to the distribution server">
+ <target name="publish.upload" depends="prepare.publish" if="ready"
+ description="Uploads distribution files">
<echo>
Uploading distribution files from
${dist.dir}
@@ -691,6 +731,9 @@
verbose="true" failonerror="true" trust="yes">
<fileset dir="${dist.dir}"/>
</scp>
+ </target>
+
+ <target name="publish.howto">
<echo>
***** RELEASE INSTRUCTIONS *****
@@ -725,7 +768,8 @@
/www/www.apache.org/dist/velocity/tools
* Tag the release in SVN with a command such as:
- svn copy -m "Release Tools ${project.version}"
https://svn.apache.org/repos/asf/velocity/tools/trunk \
+ svn copy -m "Release Tools ${project.version}" -r [revision #] \
+ https://svn.apache.org/repos/asf/velocity/tools/trunk \
https://svn.apache.org/repos/asf/velocity/tools/tags/${project.version}
* Publish the documentation for this release on the website using 'ant
publish.docs'
@@ -739,6 +783,9 @@
</echo>
</target>
+ <target name="publish" depends="publish.upload,publish.howto" if="ready"
+ description="Uploads distribution files to server for release"/>
+
<target name="publish.docs" depends="docs,publish.auth" if="have.auth"
description="Updates development documentation on the website">
<mkdir dir="${dist.dir}"/>
