incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r805027 - in /websites/staging/odftoolkit/trunk: ./ content/odftoolkit/odftoolkit-release-guide.html
Date Thu, 16 Feb 2012 05:53:52 GMT
Author: buildbot
Date: Thu Feb 16 05:53:52 2012
New Revision: 805027

Staging update by buildbot for odftoolkit

    websites/staging/odftoolkit/trunk/   (props changed)

Propchange: websites/staging/odftoolkit/trunk/
--- cms:source-revision (original)
+++ cms:source-revision Thu Feb 16 05:53:52 2012
@@ -1 +1 @@

Modified: websites/staging/odftoolkit/trunk/content/odftoolkit/odftoolkit-release-guide.html
--- websites/staging/odftoolkit/trunk/content/odftoolkit/odftoolkit-release-guide.html (original)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/odftoolkit-release-guide.html Thu
Feb 16 05:53:52 2012
@@ -112,6 +112,136 @@
 <li>The ODF Toolkit build system requires <a href="">Maven</a>
to perform a build. We suggest you install version later than 2.2.1 or 3.0.4.<br />
+<h2 id="ii-legal-audit">II. Legal Audit</h2>
+<p>Legal policy and interpretation changes from time to time so it is worth investing
a little time reading again the legal release material.<br />
+<li>Check that dependencies (and in particular those dependencies that ship in the
packages) comply with Apache policy. Apache projects may distribute artifacts and documents
as part of a release which are not Apache Licensed. All such artifacts must comply with <a
href="">Apache's 3rd party licensing policy</a>.
 <br />
+    All the licenses on all the files to be included within a package should be included
in the LICENSE document.      <br />
+<li>The NOTICE document is for additional copyright and attribution statements those
licenses may require. A typical NOTICE document at a minimum includes a copyright and attribution
statement for The Apache Software Foundation. Nothing else belongs in the NOTICE document.
       <br />
+<li>It is good practice to check the provenance of any source documents which do not
have license headers. With the help of RAT, you can run Maven command: 'mvn verify -Ppedantic'
on the "trunk" to get a report about the license header.    <br />
+<li>Make sure every committer have a signed <a href="">Contributor
License Agreement (CLA)</a> on file. It's a contract between a contributor and Apache
granting Apache rights to code contributed.          <br />
+<li>If any dependencies are cryptographic libraries then it may be necessary to fill
in some <a href="">paperwork</a> to make
sure they are compliance with US export regulations.     <br />
+<h2 id="iii-release-document">III. Release Document</h2>
+<p>Documents a particular release of a product rather than the product itself. For
a release manager, the first thing he should do is to consult and correct the project's release
documentation. For ODF Toolkit, we should make sure the following items are ready.  <br
+<li>Ensure the CHANGES.txt is up to date.</li>
+<li>The Cookbook was updated to support the new release, add new content and modify
the old parts.  <br />
+<li>Make sure all of the demo codes work well under the new release. If necessary,
write new demo to introduce the key new features in the new version. <br />
+<li>Remember to update the online Javadoc to the newest version, but don't publish
until the vote pass.  <br />
+<li>Prepare other website update content, save them as staged, but don't publish until
the vote pass.  <br />
+<h2 id="iv-release-candidate">IV. Release Candidate</h2>
+<p>A release candidate is a set of artifacts upon which a vote is held for a release.
The actual nature of the release candidate depends on the release system adopted by a the
project. For ODF Toolkit, we supply 3 type of artifacts, binary package, source package and
document package. Making release artefacts should follow the following steps:    <br />
+<p>Update version id in pom.xml.</p>
+<p>{code} <br />
+     <groupId>org.apache.odftoolkit</groupId> <br />
+     <artifactId>odftoolkit</artifactId> <br />
+     <version>0.6-incubating-SNAPSHOT</version><br />
+  {code} </p>
+<p>The version should include incubating (or incubator) to ensure that the artifacts
created comply with <a href="">Incubator
release policy</a>. </p>
+<p>Tag current version.     <br />
+    Include the current revision number in the comment. <br />
+   {code} <br />
+      $ svn cp   <br />
+$TAG   <br />
+      -m "tag r649911 as odftoolkit-0.5-incubating"  <br />
+   {code} </p>
+<p>Where $TAG is the release tag, for example, odftoolkit-0.5-incubating. <br />
+<p>Checkout the tagged version. <br />
+       {code}   <br />
+          cd tags  <br />
+          svn checkout$TAG  <br />
+       {code} <br />
+<p>Build artifacts.  <br />
+       {code} <br />
+          cd $TAG  <br />
+          mvn install  <br />
+       {code}       <br />
+<p>Package artifacts  <br />
+       Comment the following snippet in pom.xml to avoid duplicated package in sub-components:
+       {code}  <br />
+          <modules>  <br />
+             <module>taglets</module>  <br />
+             <module>generator</module> <br />
+             <module>xslt-runner</module> <br />
+             <module>xslt-runner-task</module>  <br />
+             <module>odfdom</module>  <br />
+             <module>validator</module> <br />
+             <module>simple</module> <br />
+          </modules> <br />
+       {code}<br />
+       Remove the comments of the following snippet in pom.xml to make sure Maven know how
to package:   <br />
+       {code} <br />
+          <!--<profile>klzzwxh:0036             <id>apache-release</id>
klzzwxh:0037             <properties> klzzwxh:0038                <username>${}</username>
klzzwxh:0039             </properties> klzzwxh:0040             <build> klzzwxh:0041
               <plugins> klzzwxh:0042        ...
+        </plugins> klzzwxh:0043         </build> klzzwxh:0044          </profile>-->
<br />
+       {code} <br />
+       Replace "${}" with your Apache ID, such as "devinhan". <br />
+       Use the following command to package. <br />
+       {code}  <br />
+          mvn install -Papache-release     <br />
+       {code}     <br />
+       After package you should have the following files in the "target": <br />
+       {code}        <br />
+          $TAG-bin.tar.bz2  <br />
+          $TAG-bin.tar.gz <br />
+          $ <br />
+          $TAG-src.tar.bz2  <br />
+          $TAG-src.tar.gz  <br />
+          $  <br />
+          $TAG-doc.tar.bz2  <br />
+          $TAG-doc.tar.gz <br />
+          $ <br />
+<em>.asc <br />
+</em>.md5 <br />
+          *.sha <br />
+          vote.txt <br />
+    {code} <br />
+        vote.txt is a draft of the dev vote mail. Each package has its own .asc, .md5 and
.asc files.  <br />
+<p>Upload artifacts for vote. <br />
+    Login using your Apache LDAP account. Copy the artifacts packages to
directory "/public_html/odftoolkit-release/$TAG" using <a href="">scp</a>.
If the directly don't exist, please create. It is best to scp into the home directory and
then copy into position from there.       <br />
+    Make sure all of the files are owned by the incubator group, group readable and writable,
and read only for the world. In short -rw-rw-r--. To do this from the top level:        <br
+       {code} <br />
+          &gt; find . -type f -exec chmod 664 {} ;   <br />
+      &gt; find . -type d -exec chmod 775 {} ;   <br />
+      &gt; chgrp -R incubator *  <br />
+       {code}            <br />
+       Then the artifacts can be accessed from Web browser. The link looks like: <br />
+       {code}  <br />
+$USER/odftoolkit-release/$TAG      <br />
+       {code}      <br />
+       Replace $USER with your Apache ID, such as "devinhan".   <br />
   <div id="footera">

View raw message