Author: gadams
Date: Fri Apr 6 21:50:14 2012
New Revision: 1310603
URL: http://svn.apache.org/viewvc?rev=1310603&view=rev
Log:
update release checklist in development docset based on info in bug 49281
Modified:
xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/release.xml
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/release.xml
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/release.xml?rev=1310603&r1=1310602&r2=1310603&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/release.xml
(original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/release.xml Fri
Apr 6 21:50:14 2012
@@ -25,100 +25,72 @@
<body>
<section id="intro">
<title>Introduction</title>
- <p>This page documents the process of creating a Apache⢠FOP release.
-FOP releases are coordinated by one member of the team (currently Christian
Geisert), so others do not ordinarily need to use this information.
-The purpose of documenting it here is to facilitate consistency, ensure that
the process is captured, and to allow others to comment on the process.</p>
- <p>The checklist below was assembled from Christian Geisert's notes. It
will be expanded in the future as he has time.</p>
+ <p>This page documents the process of creating a Apache⢠FOP release.
FOP releases are coordinated by some designated member of the team.
+ The purpose of documenting it here is to facilitate consistency,
ensure that the process is captured, and to allow others to comment on the
process.</p>
+ <p>The checklist below is based on a combination of input from from
Christian Geisert and Simon Pepping.</p>
</section>
<section id="checklist">
<title>Checklist</title>
<ul>
+ <li>Determine which open bugs must be solved before a release can take
place (release critical bugs).
+ Make this bug depend on each release critical bug and write a
short argument why the bug is release critical.</li>
<li>Determine whether this is a Release Candidate or a Release.</li>
<li>Determine whether further testing is required.</li>
<li>Commit any outstanding changes</li>
<li>Create a branch called <code>branches/fop-v_vv</code></li>
- <li>Edit release notes (<code>README</code> and
- <code>status.xml</code> in the root).</li>
- <li>Add the release to <code>news-data.xml</code>;
- remove links to release notes of older versions from this
file.</li>
- <li>Update the FAQ (<code>faq.xml</code>) to the new
release.</li>
- <li>Check and update the copyright year in NOTICE and
build.xml.</li>
+ <li>Edit release notes (<code>README</code> and
<code>status.xml</code> in the root).</li>
+ <li>Add the release to <code>news-data.xml</code>;
+ remove links to release notes of older versions from this file.</li>
+ <li>Update the FAQ (<code>faq.xml</code>) to the new release, e.g.,
update the answer for "When is the next release planned?".</li>
+ <li>Check and update the copyright year in NOTICE and build.xml.</li>
<li>Update the file <code>doap.rdf</code>, and the files
<code>index.xml</code>, <code>site.xml</code>,
<code>download.xml</code>, <code>fo.xml</code>,
- <code>maillist.xml</code>, <code>quickstartguide.xml</code>,
- <code>faq.xml</code> and <code>status.xml</code>
+ <code>maillist.xml</code>, and <code>quickstartguide.xml</code>
in directory <code>xdocs</code> for the new version.</li>
<li>Update the version numbers in the release column on the
compliance page (<code>compliance.xml</code>); update the compliance
in the release column
to the current state (development column).</li>
<li>Update version number in <code>build.xml</code> (not to be merged
back
into trunk).</li>
- <li>Copy trunk documentation directory to a new directory with
- the new version number, and update the .htaccess file for
- redirections.</li>
- <li>Copy <code>test/fotree/disabled-testcases.xml</code> and
- <code>test/layoutengine/disabled-testcases.xml</code> to the
- new version directory
- <code><version>/fotree/disabled-testcases.xml</code> and
- <code><version>/layoutengine/disabled-testcases.xml</code>.
- Copy <code>known-issues.xml</code> to the new version
- directory. Copy <code>knownissues-overview.xml</code> from the
- current to the new version directory, and update the
<code>xi:include</code>
- links in it.</li>
- <li>Update the tab names and directories in tabs.xml</li>
+ <li>Copy trunk documentation directory to a new directory with the new
version number, and update the <code>.htaccess</code> file for
+ redirections.</li>
+ <li>Copy <code>test/fotree/disabled-testcases.xml</code> and
<code>test/layoutengine/disabled-testcases.xml</code> to the
+ new version directory
<code><version>/fotree/disabled-testcases.xml</code> and
<code><version>/layoutengine/disabled-testcases.xml</code>.
+ Copy <code>known-issues.xml</code> to the new version directory.
Copy <code>knownissues-overview.xml</code> from the
+ current to the new version directory, and update the
<code>xi:include</code> links in it.</li>
+ <li>Update the tab names and directories in <code>tabs.xml</code></li>
<li>Delete the previous version directory.</li>
- <li>Update index.xml in the new version directory.</li>
- <li>Update compiling.xml in the new version directory: change
the intro for trunk to that for a release.</li>
- <li>Build the dist files (<code>build[.sh] dist</code>)
- and upload them to your web directory on
- <code>people.apache.org</code></li>
- <li>Ask on fop-dev to check the branch and the generated dist
- files for errors.</li>
+ <li>Update <code>index.xml</code> in the new version directory.</li>
+ <li>Update <code>compiling.xml</code> in the new version directory:
change the introduction for trunk to that for a release.</li>
+ <li>Build the dist files (<code>build[.sh] dist</code>) and upload
them to your web directory on <code>people.apache.org</code></li>
+ <li>Ask on <code>fop-dev</code> ML to check the branch and the
generated dist files for errors.</li>
<li>Tag the source tree with the release ID. For example, if the
release is 1.0:
<code>svn copy
https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-1_0
https://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-1_0</code></li>
- <li>Make a fresh checkout with the just created tag:
- <code>svn co
https://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-1_0</code></li>
- <li>Copy jimi and jai to lib/ (jimi-1.0.jar, jai_core.jar,
jai_codec.jar)</li>
- <li>Copy jce-jdk13-119.jar from <link
href="http://www.bouncycastle.org/latest_releases.html";>
- from http://www.bouncycastle.org/latest_releases.html</link> to
lib/</li>
- <li>Copy the hyphenation patterns jar file
- <code>fop-hyph.jar</code> to lib/ (e.g. from
- <code>http://sourceforge.net/projects/offo</code></li>
- <li>Alternatively, create a build-local.properties file that points to
the above libs.</li>
- <li>Run build[.sh] dist. Do this using Sun JDK 1.4.2_08 or later. A
Forrest installation is needed.</li>
- <li>Create signatures. Don't forget to upload your KEY:
- <code>gpg -a -b --force-v3-sigs fop-1.0-src.tar.gz</code> etc.</li>
- <li>Upload the dist and signature files to your web directory
- on people.apache.org (An account on minotaur is needed):
- <code>scp fop-1.0*.tar.gz*
- [email protected]:public_html/</code></li>
- <li>Check permissions:
- <code>chmod 664 ... ; chgrp xmlgraphics ...</code></li>
- <li>Add MD5 sums: <code>md5 fop-1.0-src.tar.gz >
- fop-1.0-src.tar.gz.md5</code> etc.</li>
+ <li>Make a fresh checkout with the just created tag: <code>svn co
https://svn.apache.org/repos/asf/xmlgraphics/fop/tags/fop-1_0</code></li>
+ <li>Copy the hyphenation patterns jar file <code>fop-hyph.jar</code>
to <code>lib</code> (e.g. from
<code>http://sourceforge.net/projects/offo</code></li>
+ <li>Alternatively, create a <code>build-local.properties</code> file
that points to the above libraries.</li>
+ <li>Run <code>build[.sh] dist</code>. Do this using Sun JDK 1.5 or
later. A Forrest installation is needed.</li>
+ <li>Create signatures. Don't forget to upload your KEY: <code>gpg -a
-b --force-v3-sigs fop-1.0-src.tar.gz</code> etc.</li>
+ <li>Upload the dist and signature files to your web directory on
people.apache.org (An account on minotaur is needed):
+ <code>scp fop-1.0*.tar.gz*
[email protected]:public_html/</code></li>
+ <li>Check permissions: <code>chmod 664 ... ; chgrp xmlgraphics
...</code></li>
+ <li>Add MD5 sums: <code>md5 fop-1.0-src.tar.gz >
fop-1.0-src.tar.gz.md5</code> etc.</li>
<li>Make a test download.</li>
- <li>Start a vote for the release on
- <code>[email protected]</code>. The message should point
- to the release files and list the MD5 sums (<code>cat
- *.md5</code>). The vote is open for 72hrs.</li>
- <li>When the release is accepted, copy the release files,
- their md5 sum files and the signature files to
- /www/www.apache.org/dist/xmlgraphics/fop/ in the
- subdirectories <code>source</code> and
- <code>binaries</code>. Create links to all files in the
- <code>fop</code> directory. Remove the links to the files of
- the previous version.</li>
- <li>Update HEADER.html and README.html in
people.apache.org:/www/www.apache.org/dist/xmlgraphics/fop/</li>
+ <li>Start a vote for the release on
<code>[email protected]</code>. The message should point
+ to the release files and list the MD5 sums (<code>cat
*.md5</code>). The vote should remain open for 72hrs.</li>
+ <li>When the release is accepted, copy the release files, their md5
sum files and the signature files to
+ <code>/www/www.apache.org/dist/xmlgraphics/fop/</code> in the
subdirectories <code>source</code> and
+ <code>binaries</code>. Create links to all files in the
<code>fop</code> directory. Remove the links to the files of
+ the previous version.</li>
+ <li>Update <code>HEADER.html</code> and <code>README.html</code> in
<code>people.apache.org:/www/www.apache.org/dist/xmlgraphics/fop/</code>.</li>
<li>Wait 24 hours (for the mirrors to catch up).</li>
- <li>Merge the changes of the subversion release branch back
- into trunk (not the version number in the build file) and
- delete the branch.</li>
+ <li>Merge the changes of the subversion release branch back into trunk
(not the version number in the build file) and
+ delete the branch.</li>
<li>Deploy the updated documentation to the FOP website.</li>
- <li>Post announcements on fop-dev and fop-user and other related
mailing lists.</li>
- <li>Ask a Bugzilla admin (Christian Geisert) to add a bugzilla
- entry for the new release id, or create an issue at
- <code>https://issues.apache.org/jira/browse/INFRA</code>.</li>
+ <li>Post announcements on <code>fop-dev</code> and
<code>fop-user</code> and other related mailing lists.</li>
+ <li>Ask an FOP bugzilla admin to add a bugzilla entry for the new
release id, or create an issue at
<code>https://issues.apache.org/jira/browse/INFRA</code>.</li>
+ <li>Deploy the maven bundle.</li>
</ul>
</section>
<section id="other-checklists">
@@ -129,6 +101,7 @@ The purpose of documenting it here is to
<li><jump
href="http://svn.apache.org/repos/asf/ant/core/trunk/ReleaseInstructions";>Apache
Ant</jump></li>
<li><jump
href="http://jakarta.apache.org/cactus/participating/release_checklist.html";>Apache
Cactus</jump></li>
</ul>
+ <p/>
<p>Following are links with information about mirroring:</p>
<ul>
<li><jump href="http://www.apache.org/dev/mirrors.html";>Apache
Mirroring</jump></li>
@@ -137,7 +110,7 @@ The purpose of documenting it here is to
</section>
<section id="announcements">
<title>Announcing the release</title>
- <p>Here's a collected list of places where to announce new FOP
releases:</p>
+ <p>Here's a suggested list of places where to announce new FOP
releases:</p>
<ul>
<li>[email protected]</li>
<li>[email protected]</li>
@@ -145,15 +118,14 @@ The purpose of documenting it here is to
<li>[email protected]</li>
<li>[email protected] (from your apache.org address)</li>
<li>[email protected] (subscriber-only)</li>
- <li>[email protected] (subscriber-only)</li>
+ <li>[email protected] (subscriber-only)</li>
<li>[email protected]</li>
<li>[email protected] (subscriber-only)</li>
<li>[email protected] (subscriber-only)
(http://dita-ot.sourceforge.net/)</li>
<li>http://xslfo-zone.com/news/index.jsp</li>
<li>http://www.w3.org/Style/XSL/</li>
<li>http://freshmeat.net/projects/fop/</li>
- <li>any others?</li>
</ul>
</section>
</body>
-</document>
\ No newline at end of file
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
