+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ====================================================================
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- ====================================================================
--->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd">
-
-<document>
- <header>
- <title>POI Release Guide</title>
- <authors>
- <person name="Yegor Kozlov" email="yegor@apache.org"/>
- </authors>
- </header>
-
- <body>
- <section>
- <title>POI Release Guide</title>
-
- <section><title>Prerequisites</title>
-
- <ol>
- <li> You should read the <link href="http://apache.org/dev/release.html">Apache Release FAQ</link></li>
- <li> You must have shell access to people.apache.org</li>
- <li> Release manager must have his public key appended to the KEYS file checked in to SVN and the key published on one of the public key servers.
- More info can be found here: <link href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</link></li>
- <li> You must have <link href="http://java.sun.com">JDK 1.4 / 1.5</link></li>
- <li> You must have the following utilities installed on your local machine and available in your path:
- <ul>
- <li><link href="http://www.openssh.com">ssh</link></li>
- <li><link href="http://www.gnupg.org">gnupg</link></li>
- <li><link href="http://www.openssl.org">openssl</link></li>
- </ul>
- For Windows users, install Cygwin and make sure you have the above components.
- </li>
- <li> The POI build system requires two components to perform a build
- <ul>
- <li><link href="http://ant.apache.org">Ant</link></li>
- <li><link href="http://forrest.apache.org/">Forrest</link></li>
- </ul>
- </li>
- </ol>
- </section>
- <section><title>Building Release Artifacts</title>
- <ul>
- <li>Ensure the changelog is up to date</li>
- <li>Tag SVN:
- <br/>
- <code> svn cp https://svn.apache.org/repos/asf/poi/trunk \ </code> <br/>
- <code> https://svn.apache.org/repos/asf/poi/tags/REL_3_0_2_BETA1 \ </code> <br/>
- <code> -m "tag trunk as REL_3_0_2_BETA1" </code>
- </li>
- <li>Update version.id in build.xml</li>
- <li>Start a new section for the next release in xdocs/sites.xml and status.xml in the documentation/content/xdocs directory</li>
- <li>Checkout the new tag:<br/>
- <code>
- svn checkout https://svn.apache.org/repos/asf/poi/tags/REL_3_0_2_BETA1
- </code>
- </li>
- <li>Merge if needed: <br/>
- <code> cd tags/REL_3_0_2_BETA1 </code><br/>
- <code> svn merge https://svn.apache.org/repos/asf/poi/tags/REL_3_0_2_BETA1 \ </code> <br/>
- <code> https://svn.apache.org/repos/asf/poi/trunk </code>
- </li>
- <li>Build as if the vote had passed. <br/>
- Typically a release vote lasts 7 days so the filename dates should be +7 days from current date.<br/>
- <code> cd tags/REL_3_0_2_BETA1 </code><br/>
- Main distribution:<br/>
- <code> ant dist </code> <br/>
- Maven artifacts:<br/>
- <code> ant maven-dist </code>
- </li>
- <li>Create MD5 checksums for all artifacts to be published:<br/>
- <code>openssl md5 < file > file.md5</code><br/>
- </li>
- <li>Signing all artifacts to be published:<br/>
- <code>gpg --armor --output file.asc --detach-sig $file; </code><br/>
- Verify signatures:
- <code>gpg --verify file.asc file</code><br/>
- </li>
- <li>Upload to your area at people.apache.org<br/></li>
- </ul>
- </section>
-
- </section>
- </body>
-</document>
--- /dev/null
+POI Release Guide\r
+\r
+\r
+(I) Prerequisites\r
+\r
+ 1. You should read the <a href="http://apache.org/dev/release.html">Apache Release FAQ</a>\r
+ 2. You must have shell access to people.apache.org\r
+ 3. Release manager must have his public key appended to the KEYS file checked in to SVN and the key published on one of the public key servers.\r
+ More info can be found here: <a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a>\r
+ 4. You must have <a href="java.sun.com">JDK 1.4 / 1.5</a>\r
+ 5. You must have the following utilities installed on your local machine and available in your path:\r
+ * <a href="www.openssh.com">ssh</a>\r
+ * <a href="www.gnupg.org">gnupg</a>\r
+ * <a href="www.openssl.org">openssl</a>\r
+ For Windows users, install Cygwin and make sure you have the above utilities\r
+ 6. The POI build system requires two components to perform a build\r
+ * <a href="ant.apache.org">Ant</a> \r
+ * <a href="http://forrest.apache.org/">Forrest</a>. \r
+ POI 3.0.2 and 3.1 were built using Ant 1.6.2 and Forrest 0.5\r
+\r
+(II) Making release artefacts\r
+ 1. Update version id in build.xml. \r
+ 2. Tag current version. Include the current revision number in the comment\r
+\r
+{code}\r
+$ svn cp https://svn.apache.org/repos/asf/poi/trunk \\r
+https://svn.apache.org/repos/asf/poi/tags/$TAG \\r
+-m "tag r649911 as 3.1-beta1"\r
+{code}\r
+\r
+where $TAG is the release tag, for example, REL_3_1_BETA1\r
+\r
+ 3. Checkout the tagged version\r
+{code}\r
+cd tags\r
+svn checkout https://svn.apache.org/repos/asf/poi/tags/TAG\r
+{code}\r
+\r
+ 4. Merge (if required)\r
+\r
+{code}\r
+cd $TAG\r
+$ svn merge https://svn.apache.org/repos/asf/poi/tags/TAG \\r
+https://svn.apache.org/repos/asf/poi/trunk\r
+{code}\r
+\r
+ 5. Start a new section in sites.xml and status.xml. \r
+\r
+ 6. Build as if the vote had passed. The buid date must be +7 days from current.\r
+{code}\r
+ant build\r
+{code}\r
+After build you should have the following files in the build/dist:\r
+\r
+{code}\r
+poi-$TAG-$DATE.jar\r
+poi-bin-$TAG-$DATE.tar.gz\r
+poi-bin-$TAG-$DATE.zip\r
+poi-contrib-$TAG-$DATE.jar\r
+poi-scratchpad-$TAG-$DATE.jar\r
+poi-src-$TAG-$DATE.tar.gz\r
+poi-src-$TAG-$DATE.zip\r
+{code}\r
+\r
+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). \r
+ 7. Build Mavn POM files\r
+{code}\r
+ant maven-dist\r
+{code}\r
+\r
+ 8. Signing the release artifacts:\r
+{code}\r
+cd build/dist\r
+for i in *.zip ; do \r
+ gpg --armor --output $i.asc --detach-sig $i; \r
+done\r
+for i in *.gz ; do \r
+ gpg --armor --output $i.asc --detach-sig $i; \r
+done\r
+{code}\r
+\r
+Verify the signatures:\r
+\r
+{code}\r
+gpg --multifile --verify *.asc\r
+{code}\r
+\r
+ 9. Create MD5 checksums for all artifacts to be published:\r
+\r
+{code}\r
+for i in *.zip ; do \r
+ openssl md5 < $i > $i.md5\r
+done\r
+for i in *.gz ; do \r
+ openssl md5 < $i > $i.md5\r
+done\r
+{code}\r
+\r
+ 10. Upload to your area at people.apache.org.\r
+There should be two directories:\r
+main\r
+maven\r
+\r
+Make sure that the all files have read permission. \r
+\r
+ (III) After the vote:\r
+\r
+Log-in on people.apache.org\r
+\r
+1. Go to ~/POI-3.1-BETA1\r
+\r
+cd ~/POI-3.1-BETA1/main\r
+\r
+BETA and ALPHA releases:\r
+cp *-src-* /www/www.apache.org/dist/poi/dev/src\r
+cp *-bin-* /www/www.apache.org/dist/poi/dev/bin\r
+\r
+FINAL release:\r
+cp *-src-* /www/www.apache.org/dist/poi/release/src\r
+cp *-bin-* /www/www.apache.org/dist/poi/release/bin\r
+\r
+cd ~/POI-3.1-BETA1/maven\r
+\r
+cp -r org.apache.poi /www/people.apache.org/repo/m1-ibiblio-rsync-repository/\r
+cp -r poi/poms /www/people.apache.org/repo/m1-ibiblio-rsync-repository/poi\r
+\r
+\r
+2. Make sure that the files are owned by the unix group apcvs and that they are writable by this group. \r
+\r
+3. Wait for the distributions to appear on your favourite mirror\r
+\r
+4. Send announcements:\r
+ - to poi-user and poi-dev lists\r
+ - send announcements to announcement@apache.org, announcements@jakarta.apache.org\r
+\r
projects / poi.git / commitdiff