You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2013/06/26 00:37:57 UTC
svn commit: r1496658 - /poi/site/src/documentation/release-guide.txt
Author: nick
Date: Tue Jun 25 22:37:57 2013
New Revision: 1496658
URL: http://svn.apache.org/r1496658
Log:
Update the release guide - docs are an external, a few things are better done in a different order, and add a bit of explanation in places
Modified:
poi/site/src/documentation/release-guide.txt
Modified: poi/site/src/documentation/release-guide.txt
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/release-guide.txt?rev=1496658&r1=1496657&r2=1496658&view=diff
==============================================================================
--- poi/site/src/documentation/release-guide.txt (original)
+++ poi/site/src/documentation/release-guide.txt Tue Jun 25 22:37:57 2013
@@ -36,13 +36,23 @@
6. The POI build system requires two components to perform a build
* <a href="ant.apache.org">Ant</a>
* <a href="http://forrest.apache.org/">Forrest</a>.
- POI 3.0.2 and 3.1 were built using Ant 1.6.2 and Forrest 0.5
+ POI 3.0.2 and 3.1 were built using Ant 1.6.2 and Forrest 0.5
+ Currently, Forrest needs to be 0.5.1, Ant 1.7+ should be fine
7. Before building, you should run the "rat-check" build task, which
uses <a href="http://incubator.apache.org/rat/">Apache Rat</a>
to check the source tree for files lacking license headers. Files
without headers should be either fixed, or added to the exlude list
+ 8. Check file permissions are correct in SVN.
+ There can be files in the SVN tree marked executable (have the
+ svn:executable property set), but which should not be. Checking them
+ out will cause the executable bit to be set for them on filesystems
+ which support it. The flag can be removed in batch using
+
+$ svn pd 'svn:executable' $(find -name .svn -prune -or -type f ! -name \*.sh \
+ -print0 | xargs -0 svn pg 'svn:executable' | cut -d ' ' -f 1)
+
(II) Making release artefacts
1. Update version id in build.xml
@@ -50,18 +60,18 @@
<property name="version.id" value="3.1-beta1"/>
{code}
+ 2. Update the date in src/documentation/content/xdocs/status.xml with
+ the expected release date, and create a commented out entry for the
+ next release. (Must be commented out, as there are no actions
+ for it yet)
+
+ 3. Pin the documentation explicitly to the current version, rather
+ than trunk. Run "svn up" to get the current version number, then
+ edit the svn:externals property on src and add to the definition, eg
- 1a Check file permissions in SVN.
- There can be files in the SVN tree marked executable (have the
- svn:executable property set), but which should not be. Checking them out will cause
- the executable bit to be set for them on filesystems which support it.
- The flag can be removed in batch using
-
-$ svn pd 'svn:executable' $(find -name .svn -prune -or -type f ! -name \*.sh \
- -print0 | xargs -0 svn pg 'svn:executable' | cut -d ' ' -f 1)
+ documentation -r1496657 https://svn.apache.org/repos/asf/poi/site/src/documentation
-
- 2. Tag current version. Include the current revision number in the comment
+ 4. Tag current version. Include the current revision number in the comment
{code}
$ svn cp https://svn.apache.org/repos/asf/poi/trunk \
@@ -71,13 +81,16 @@ https://svn.apache.org/repos/asf/poi/tag
where $TAG is the release tag, for example, REL_3_1_BETA1
- 3. Checkout the tagged version
+ 5. On trunk, update "version.id" to be the next version, and remove
+ the version pinning on the documentation external definition.
+
+ 6. Checkout the tagged version
{code}
cd tags
svn checkout https://svn.apache.org/repos/asf/poi/tags/$TAG
{code}
- 4. Merge (if required)
+ 7. Merge (if required)
{code}
cd $TAG
@@ -85,9 +98,11 @@ $ svn merge https://svn.apache.org/repos
https://svn.apache.org/repos/asf/poi/trunk
{code}
- 5. Start a new section in status.xml.
+ Note that if there's set to be lots of merging, you may be best
+ to create a branch for the release, then create tags from there
+ rather than trunk
- 6. Build as if the vote had passed. The build date must be +7 days from current.
+ 8. Build as if the vote had passed. The build date must be +7 days from current.
{code}
# eg ant -DDSTAMP=20100924 dist
ant -DDSTAMP=YYYYMMDD dist
@@ -95,14 +110,14 @@ ant -DDSTAMP=YYYYMMDD dist
where $TAG is the release tag specified in build.xml in the version.id property, $DATE is the release date (typically +7 days from the actual build date).
- 7. Signing the release artifacts:
+ 9. Signing the release artifacts:
{code}
cd build/dist
./multisign.sh
- 8. Upload to the dev svn dist repo,
- https://dist.apache.org/repos/dist/dev/poi/ eg
- https://dist.apache.org/repos/dist/dev/poi/3.8-RC3/
+ 10. Upload to the dev svn dist repo,
+ https://dist.apache.org/repos/dist/dev/poi/ eg
+ https://dist.apache.org/repos/dist/dev/poi/3.8-RC3/
How to upload:
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org