You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@chemistry.apache.org by ga...@apache.org on 2011/03/22 22:44:33 UTC
svn commit: r787399 - in /websites/production/chemistry: ./
content/internal/opencmis-maven-release-documentation.html
content/java/developing/opencmis-layers.png
content/java/how-to/how-to-create-server.html
Author: gabriele
Date: Tue Mar 22 21:44:32 2011
New Revision: 787399
Log:
Publishing updated release docs
Added:
websites/production/chemistry/content/java/developing/opencmis-layers.png
- copied unchanged from r787398, websites/staging/chemistry/trunk/content/java/developing/opencmis-layers.png
Modified:
websites/production/chemistry/ (props changed)
websites/production/chemistry/content/internal/opencmis-maven-release-documentation.html
websites/production/chemistry/content/java/how-to/how-to-create-server.html
Propchange: websites/production/chemistry/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Mar 22 21:44:32 2011
@@ -1 +1 @@
-/websites/staging/chemistry/trunk:785583-787341
+/websites/staging/chemistry/trunk:785583-787398
Modified: websites/production/chemistry/content/internal/opencmis-maven-release-documentation.html
==============================================================================
--- websites/production/chemistry/content/internal/opencmis-maven-release-documentation.html (original)
+++ websites/production/chemistry/content/internal/opencmis-maven-release-documentation.html Tue Mar 22 21:44:32 2011
@@ -183,73 +183,86 @@ Apache Chemistry - OpenCMIS Maven Releas
</td>
<td height="100%">
<!-- Content -->
- <div class="wiki-content"><ul>
-<li><a href="#OpenCMISMavenReleaseDocumentation-OpenCMISReleaseDocumentation">OpenCMIS Release Documentation</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-Introduction">Introduction</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-BuildEnvironments">Build Environments</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-ReleaseArtifacts">Release Artifacts</a>
- * <a href="#OpenCMISMavenReleaseDocumentation-DocumentationandJavaDoc">Documentation and JavaDoc</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-Preparation">Preparation</a><ul>
-<li><a href="#OpenCMISMavenReleaseDocumentation-ReleaseManager">Release Manager</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-Version">Version</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-OpenIssues">Open Issues</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-UnitTestsandIntegrationTests">Unit Tests and Integration Tests</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-ApacheLicenseandCodeStyle">Apache License and Code Style</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-ReleaseNotes">Release Notes</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-ReleaseTag">Release Tag</a></li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-ReleaseBranch">Release Branch</a></li>
+ <div class="wiki-content"><div class="toc">
+<ul>
+<li><a href="#opencmis_release_documentation">OpenCMIS Release Documentation</a><ul>
+<li><a href="#introduction">Introduction</a></li>
+<li><a href="#build_environments">Build Environments</a></li>
+<li><a href="#release_artifacts">Release Artifacts</a><ul>
+<li><a href="#documentation_and_javadoc">Documentation and JavaDoc</a></li>
+</ul>
+</li>
+<li><a href="#preparation">Preparation</a><ul>
+<li><a href="#release_manager">Release Manager</a></li>
+<li><a href="#version">Version</a></li>
+<li><a href="#open_issues">Open Issues</a></li>
+<li><a href="#unit_tests_and_integration_tests">Unit Tests and Integration Tests</a></li>
+<li><a href="#apache_license_and_code_style">Apache License and Code Style</a></li>
+<li><a href="#packaging">Packaging</a></li>
+<li><a href="#release_tag">Release Tag</a></li>
+<li><a href="#release_branch">Release Branch</a></li>
+</ul>
+</li>
+<li><a href="#release_candidate">Release Candidate</a><ul>
+<li><a href="#publishing_the_release">Publishing The Release</a></li>
</ul>
</li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-ReleaseCandidate">Release Candidate</a><ul>
-<li><a href="#OpenCMISMavenReleaseDocumentation-PublishingTheRelease">Publishing The Release</a></li>
+<li><a href="#post_release_cleanup">Post Release Cleanup</a></li>
</ul>
</li>
-<li><a href="#OpenCMISMavenReleaseDocumentation-PostReleaseCleanup">Post Release Cleanup</a></li>
</ul>
-<p><a name="OpenCMISMavenReleaseDocumentation-OpenCMISReleaseDocumentation"></a></p>
+</div>
<h1 id="opencmis_release_documentation">OpenCMIS Release Documentation</h1>
<p><a name="OpenCMISMavenReleaseDocumentation-Introduction"></a></p>
<h2 id="introduction">Introduction</h2>
<p>This document describes the release process for Apache Chemistry OpenCMIS.
It heavily refers to <a href="http://maven.apache.org/developers/release/apache-release.html">standard Apache procedures to release</a>
- Maven based projects at Apache. Also [general incubator best practices|http://incubator.apache.org/guides/releasemanagement.html]
- have been implemented.</p>
+ Maven based projects at Apache.</p>
<p><a name="OpenCMISMavenReleaseDocumentation-BuildEnvironments"></a></p>
<h2 id="build_environments">Build Environments</h2>
-<p>OpenCMIS is built and released with <a href="http://maven.apache.org">Maven2</a>
- and uses the [Apache POM version 7|http://svn.apache.org/repos/asf/maven/pom/tags/apache-7/pom.xml]
- .</p>
+<p>OpenCMIS is built and released with <a href="http://maven.apache.org">Maven2</a> and uses the <a href="http://svn.apache.org/repos/asf/maven/pom/tags/apache-9/pom.xml">Apache POM version 9</a>.</p>
<p><a name="OpenCMISMavenReleaseDocumentation-ReleaseArtifacts"></a></p>
<h2 id="release_artifacts">Release Artifacts</h2>
-<p>An OpenCMIS release (<a href="https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~0.1.0-incubating-SNAPSHOT">see an exampled of all released packages here</a>
-) consists of:</p>
+<p>An OpenCMIS release (<a href="https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~0.3.0-SNAPSHOT">see an exampled of all released packages here</a>) consists of:</p>
<ul>
-<li>
-<p>All POMs/JARs/WARs built as part of the standard Maven build process. For
+<li>All POMs/JARs/WARs built as part of the standard Maven build process. For
an overview on the released modules see artifacts with groupId
-<em>org.apache.chemistry.opencmis</em> in the <a href="https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~~~">Apache Maven Repository</a>
-. In detail, per every module, where applicable, the following artifacts
-are produced:
-<strong> <em>Main artifact</em>: <em><artifactId>-<version>.<ext></em></strong> <em>Source artifact</em>: <em><artifactId>-<version>-sources.<ext></em>
-<strong> <em>Javadoc artifact</em>: <em><artifactId>-<version>-javadoc.<ext></em></strong> <em>POM</em>: <em><artifactId>-<version>.pom</em></p>
+<em>org.apache.chemistry.opencmis</em> in the <a href="https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~~~">Apache Maven Repository</a>. In detail, per every module, where applicable, the following artifacts
+are produced:</li>
+<li><strong>Main artifact</strong>: <code><artifactId>-<version>.<ext></code></li>
+<li><strong>Source artifact</strong>: <code><artifactId>-<version>-sources.<ext></code></li>
+<li><strong>Javadoc artifact</strong>: <em><artifactId>-<version>-javadoc.<ext></em></li>
+<li>
+<p><strong>POM</strong>: <code><artifactId>-<version>.pom</code></p>
</li>
<li>
<p>Also the following additional <em>distribution commodity packages</em> are
-provided as part of the release:
-<strong> A source-release bundle containing all files the sources necessary to
-build all other artifacts.
-<strong><em> <em>Package formats</em>: zip. </em></strong> <em>Name</em>: <em>chemistry-opencmis-<version>-source-release.<ext></em></strong> A package containing offline HTML documentation and the full javadocs:
-<strong><em> <em>Package formats</em>: tar.gz and zip. </em></strong> <em>Name</em>: <em>chemistry-opencmis-<version>-docs.<ext></em>
-<strong> A client distribution bundle with all the client related JARs:
-<strong><em> <em>Package formats</em>: tar.gz and zip. </em></strong> <em>Name</em>: <em>chemistry-opencmis-dist-<version>-client.<ext></em></strong> A client bundle (as above) with OpenCMIS Client JARs and all
-dependencies.
-<strong><em> <em>Package formats</em>: tar.gz and zip. </em></strong> <em>Name</em>:
-<em>chemistry-opencmis-client-impl-<version>-with-dependencies.<ext></em>
-<strong> A bundle containing the OpenCMIS server WARs and support
-<strong><em> <em>Package formats</em>: tar.gz and zip. </em></strong> <em>Name</em>: <em>chemistry-opencmis-dist-<version>-server.<ext></em></strong> A bundle containing all OpenCMIS server related WARs (<em>inmemory,
-fileshare, browser)</em>
-<strong><em> <em>Package formats</em>: tar.gz and zip. </em></strong> <em>Name</em>: <em>chemistry-opencmis-dist-<version>-server-webapps.<ext></em></p>
+provided as part of the release:</p>
</li>
+<li>
+<p><code>chemistry-opencmis-<version>-source-release.<ext></code> <br/> A source-release bundle containing all files the sources necessary to
+build all other artifacts. <strong>Package formats</strong>: zip. </p>
+</li>
+<li><code>chemistry-opencmis-dist-<version>-docs.<ext></code> <br/>
+ A package containing offline HTML documentation and the full javadocs for the latest release.
+<strong>Package formats</strong>: tar.gz and zip. </li>
+<li><code>chemistry-opencmis-dist-<version>-client.<ext></code> <br/>
+ A client distribution bundle with all the client related JARs.
+<strong>Package formats</strong>: tar.gz and zip. </li>
+<li><code>chemistry-opencmis-client-impl-<version>-with-dependencies.<ext></code> <br/>
+ A client bundle (as above) with OpenCMIS Client JARs and all
+dependencies.
+<strong>Package formats</strong>: tar.gz and zip. </li>
+<li><code>chemistry-opencmis-server-support-<version>.<ext></code> <br/>
+ A WAR bundle containing the OpenCMIS server support
+<strong>Package formats</strong>: WAR;</li>
+<li><code>chemistry-opencmis-dist-<version>-server-webapps.<ext></code> <br/>
+ A bundle containing all OpenCMIS server related WARs (inmemory,
+fileshare, browser)
+<strong>Package formats</strong>: tar.gz and zip;</li>
+<li><code>chemistry-opencmis-workbench-<version>-full.<ext></code> <br/>
+ ZIP/Tar.gz bundles containing OpenCMIS workbench client application
+<strong>Package formats</strong>: tar.gz and zip;</li>
</ul>
<p><a name="OpenCMISMavenReleaseDocumentation-DocumentationandJavaDoc"></a></p>
<h4 id="documentation_and_javadoc">Documentation and JavaDoc</h4>
@@ -257,10 +270,11 @@ fileshare, browser)</em>
examples in the documentation must work. The Java package documentation
must be up-to-date. The JavaDoc must be generated with Maven without
warnings.</p>
-<p>The Maven site documentation will be generated as part of the release and deployed as part of the vote at http:/people.apache.org/~gabriele/opencmis/<version> (<a href="http://people.apache.org/~gabriele/chemistry/opencmis/0.1.0-incubating-SNAPSHOT/">see an example</a>
-) .
-Later, upon release approval, this will be synced in a sub folder of <a href="http://incubator.apache.org/chemistry/">http://incubator.apache.org/chemistry/</a>
- and linked from the wiki home page. This will allow to publish up to date
+<p>The Maven site documentation will be generated as part of the release and deployed as part of the vote
+at <p> <code>http:/people.apache.org/~gabriele/opencmis/<version></code> </p> (see <a href="http://people.apache.org/~gabriele/chemistry/opencmis/0.3.0-dryrun/">example</a> here).</p>
+<p>Later, upon release approval, this will be synced in the per release sub folder
+<p><code>http://chemistry.apache.org/java/<version>/maven</code></p>
+and linked from the wiki home page. This will allow to publish up to date
Java Doc and test reports.</p>
<p><a name="OpenCMISMavenReleaseDocumentation-Preparation"></a></p>
<h2 id="preparation">Preparation</h2>
@@ -288,14 +302,9 @@ open issues for future releases.</p>
<p>Each source code file must have a current ASF license header. The source
code should follow the OpenCMIS code style.</p>
<p><a name="OpenCMISMavenReleaseDocumentation-ReleaseNotes"></a></p>
-<h3 id="release_notes">Release Notes</h3>
-<p>Each release must provide a RELEASE-NOTES.txt file in the base directory of
-the source bundle. It must contain all known issues and should contain a
-description of all the changes since the previous release. The release
-notes should also contain the minimum target Java version and a list of all
-dependencies with their minimum version.
-NOTICE.txt and LICENSE.txt must be present in all bundles and must be
-up-to-date.</p>
+<h3 id="packaging">Packaging</h3>
+<p>NOTICE and LICENSE must be present in all bundles and must be
+up-to-date. A special mention is added for 3rd party packages included in OpenCMIS artifacts.</p>
<p><a name="OpenCMISMavenReleaseDocumentation-ReleaseTag"></a></p>
<h3 id="release_tag">Release Tag</h3>
<p>A tag has to be created for every release candidate. The naming rule for
@@ -317,15 +326,14 @@ starting with 1. If more than one releas
has to be created and release candidate number will be increased by one.</p>
<p>The release candidate artifacts:</p>
<ul>
-<li><em>Maven artifacts</em> will be <a href="http://incubator.apache.org/guides/releasemanagement.html">staged</a>
- on <em>repository.apache.org</em> </li>
-<li><em>Distribution commodity packages</em> are staged
-at {color:#003366}http:/people.apache.org/~<em><username></em>/opencmis/<version>/dist/{color} </li>
-<li>The <em>generated site reports/javadocs</em> will be staged
-at {color:#003366}http:/people.apache.org/~<em><username></em>/opencmis/<version>/site/{color}</li>
+<li><strong>Maven artifacts</strong> will be <a href="http://.apache.org/guides/releasemanagement.html">staged</a>
+ on <code>repository.apache.org</code>. A new staging repo is created per RC and will be communicated upon release.</li>
+<li><strong>Distribution commodity packages</strong> are staged
+at <br/> <code>http:/people.apache.org/~<username>/opencmis/<version>/dist/</code></li>
+<li>The <strong>generated site reports/javadocs</strong> will be staged
+at <br/> <code>http:/people.apache.org/~<username>/opencmis/<version>/site/</code></li>
</ul>
-<p>Once candidate artifacts are available, release manager kicks off the <a href="http://incubator.apache.org/guides/releasemanagement.html#best-practice-incubator-release-vote">VOTE process</a>
-.</p>
+<p>Once candidate artifacts are available, release manager kicks off the <a href="http://incubator.apache.org/guides/releasemanagement.html#best-practice-incubator-release-vote">VOTE process</a>.</p>
<p>If the vote fails, the raised issues will be fixed, a new release candidate
will be built and the VOTE process will be restarted.</p>
<p>If the release candidate gets approved, we can proceed to release
@@ -335,30 +343,23 @@ publishing.</p>
<p>If the release candidate gets approved, we can proceed to release
publishing:</p>
<ul>
-<li><em>release candidate maven artifacts</em> are <em>promoted</em> as in the Apache
+<li><strong>release candidate maven artifacts</strong> are <em>promoted</em> in the Apache
Maven Repository and made available at <a href="https://repository.apache.org/content/groups/public/org/apache/chemistry/">https://repository.apache.org/content/groups/public/org/apache/chemistry/</a></li>
-<li>Maven artifacts are automatically synced to Maven Central [http://repo1.maven.org/maven2]
- </li>
-<li><em>release candidate commodity packages</em> are synced (together with their
-checksum and signatures) to <a href="http://www.apache.org/dist/incubator/chemistry">http://www.apache.org/dist/incubator/chemistry</a></li>
-<li><em>maven site</em> is synced to <a href="http://incubator.apache.org/chemistry/maven-site/<version>">http://incubator.apache.org/chemistry/maven-site/<version></a>
+<li>Maven artifacts are automatically synced to Maven Central at <code>http://repo1.maven.org/maven2/org/apache/chemistry</code></li>
+<li><strong>release candidate commodity packages</strong> are synced (together with their
+checksum and signatures) to <code>http://www.apache.org/dist/chemistry</code></li>
+<li><strong>maven site</strong> is synced to <code>http://chemistry.apache.org/java/<version>/maven</code>
and back-linked from [http://incubator.apache.org/chemistry/index.html]</li>
-<li><em>project version</em> at <a href="http://incubator.apache.org/chemistry/index.html">http://incubator.apache.org/chemistry/index.html</a>
+<li><em>project version</em> at <a href="http://incubator.apache.org/chemistry/index.html">http://chemistry.apache.org/java/opencmis.html</a>
is updated</li>
<li><em>release tag is renamed</em> to final version</li>
<li>release branch is created</li>
-<li><em>Release is closed</em> in <a href="https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310936" /></li>
-<li>
-<p><em>Release is announced</em> to </p>
-</li>
-<li>
-<p>{noformat}
-general@incubator.apache.org chemistry-dev@incubator.apache.org</p>
-<p>h2. Post Release Cleanup</p>
+<li><em>Release is closed</em> in <a href="https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310936">Jira</a></li>
+<li><em>Release is announced</em> to <code>dev@chemistry.apache.org, announce@apache.org</code></li>
+</ul>
+<h2 id="post_release_cleanup">Post Release Cleanup</h2>
<ul>
<li>Remove release candidate artifacts and sites</li>
-</ul>
-</li>
</ul></div>
<!-- Content -->
</td>
Modified: websites/production/chemistry/content/java/how-to/how-to-create-server.html
==============================================================================
--- websites/production/chemistry/content/java/how-to/how-to-create-server.html (original)
+++ websites/production/chemistry/content/java/how-to/how-to-create-server.html Tue Mar 22 21:44:32 2011
@@ -357,34 +357,14 @@ may run <code>mvn eclipse:eclipse</code>
<code>.classpath</code> files for Eclipse that you just need to import in your
Eclipse workspace.</p>
<h3 id="without_maven">Without maven</h3>
-<p>If you do not want to use maven to build your project you currently have to
-use maven to produce the binaries from the source code. Download the source
-code and run</p>
-<div class="codehilite"><pre><span class="n">mvn</span> <span class="nb">package</span>
-</pre></div>
-
-
-<p>to produce a binary version of all packaged files. To reuse the relevant
-files from the server implementation in opencmis type:</p>
-<div class="codehilite"><pre><span class="n">cd</span> <span class="n">chemistry</span><span class="o">-</span><span class="n">opencmis</span><span class="o">-</span><span class="n">server</span>
-<span class="n">cd</span> <span class="n">chemistry</span><span class="o">-</span><span class="n">opencmis</span><span class="o">-</span><span class="n">server</span><span class="o">-</span><span class="n">bindings</span>
-</pre></div>
-
-
-<p>Unzip the file
-<code>chemistry-opencmis-server-bindings-0.1-incubating-SNAPSHOT.jar</code> and copy
+<p>If you do not want to use maven to build your project downlod from the downloads
+page the package "OpenCMIS Server Framework". Unzip the file and copy
the contents to your project. It includes all required jars, web.xml and
-other supporting files. In case you prefer an empty classes directory and
-use a jar instead you can use:</p>
-<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">jar:jar</span>
-</pre></div>
-
-
-<p>Then copy the file named <code>opencmis-server-impl-0.1-SNAPSHOT.jar</code> from the
-target directory to your project directory. Add all jar files from the
-<code>.war</code> and the one created in the previous step to your project setup.
-Add the <code>repository.properties</code> file to your classpath.</p>
-<p>Now you have an initial <code>web.xml</code> and the required support files for the
+other supporting files. It follow the structure of a web application (.war).
+The web application can be deployed but does not have any functionality.</p>
+<p>Edit the file <code>repository.properties</code> as a first step (see below) and take
+care that it is in your classpath.</p>
+<p>You also have an initial <code>web.xml</code> and the required support files for the
web services binding. Unless you have specific requirements you do not need
to modify them.</p>
<h2 id="implementing_the_services">Implementing the services</h2>