You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by bu...@apache.org on 2013/09/30 14:41:21 UTC
svn commit: r880497 - in /websites/staging/olingo/trunk/content: ./
doc/release.html
Author: buildbot
Date: Mon Sep 30 12:41:21 2013
New Revision: 880497
Log:
Staging update by buildbot for olingo
Modified:
websites/staging/olingo/trunk/content/ (props changed)
websites/staging/olingo/trunk/content/doc/release.html
Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Sep 30 12:41:21 2013
@@ -1 +1 @@
-1527526
+1527534
Modified: websites/staging/olingo/trunk/content/doc/release.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/release.html (original)
+++ websites/staging/olingo/trunk/content/doc/release.html Mon Sep 30 12:41:21 2013
@@ -70,14 +70,14 @@
<h1 id="apache-olingo-release-documentation">Apache Olingo Release Documentation</h1>
-<h2 id="introduction">Introduction</h2>
+<h3 id="introduction">Introduction</h3>
<p>This document describes the release guidelines for Apache Olingo. 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.</p>
-<h2 id="build-environments">Build Environments</h2>
+<h3 id="build-environments">Build Environments</h3>
<p>Apache Olingo is built and released with <a href="http://maven.apache.org">Maven3</a> and uses
the <a href="http://svn.apache.org/repos/asf/maven/pom/tags/apache-13/pom.xml">Apache POM version 13</a>.</p>
-<h2 id="release-artifacts">Release Artifacts</h2>
+<h3 id="release-artifacts">Release Artifacts</h3>
<p>An Apache Olingo release consists of:</p>
<ul>
<li>All POMs/JARs/WARs built as part of the standard Maven build process. For
@@ -86,32 +86,32 @@ an overview on the released modules see
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><strong>Javadoc artifact</strong>: <code><artifactId>-<version>-javadoc.<ext></code></li>
<li><strong>POM</strong>: <code><artifactId>-<version>.pom</code></li>
</ul>
<p>Also the following additional <em>distribution commodity packages</em> are
provided as part of the release:</p>
<ul>
<li>
-<p><code>org.apache.olingo-olingo.odata2.parent-${version}-source-release.${ext}</code> <br/> A source-release
+<p><code>org.apache.olingo-olingo-odata2-parent-incubating-${version}-source-release.${ext}</code> <br/> A source-release
bundle containing all files the sources necessary to build all other artifacts. <br/> <strong>Package formats</strong>: zip.</p>
</li>
<li>
-<p><code>org.apache.olingo-olingo.odata2.dist-${version}-javadoc.${ext}</code> <br/> A bundle containing the OData2 core
+<p><code>org.apache.olingo-olingo-odata2-dist-incubating-${version}-javadoc.${ext}</code> <br/> A bundle containing the OData2 core
library and dependencies required to implement an OData V2 processor. <br/> <strong>Package formats</strong>: zip.</p>
</li>
<li>
-<p><code>org.apache.olingo-olingo.odata2.dist-${version}-lib.${ext}</code> <br/> A bundle
+<p><code>org.apache.olingo-olingo-odata2-dist-incubating-${version}-lib.${ext}</code> <br/> A bundle
containing JavaDoc of the OData2 library API and annotations, the
JPA processor API as well as additional documentation and reference scenario
examples. <br/> <strong>Package formats</strong>: zip.</p>
</li>
<li>
-<p><code>org.apache.olingo-olingo.odata2.dist-${version}-jpa.${ext}</code> <br/> A bundle containing the OData2 JPA
+<p><code>org.apache.olingo-olingo-odata2-dist-incubating-${version}-jpa.${ext}</code> <br/> A bundle containing the OData2 JPA
processor and dependencies required to implement an OData V2 processor. <br/> <strong>Package formats</strong>: zip.</p>
</li>
<li>
-<p><code>org.apache.olingo-olingo.odata2.dist-${version}-ref.${ext}</code> <br/> A bundle containing ready-to-depoly WAR
+<p><code>org.apache.olingo-olingo-odata2-dist-incubating-${version}-ref.${ext}</code> <br/> A bundle containing ready-to-depoly WAR
files of the OData V2 reference scenarios implementations for the core library and the JPA processor. <br/> <strong>Package formats</strong>: zip.</p>
</li>
</ul>
@@ -119,18 +119,33 @@ files of the OData V2 reference scenario
<p>The documentation that will be part of the release must match the code.
All examples in the documentation must work. The Java package documentation must be
up-to-date. Release independend documentation is maintained on the <a href="http://olingo.incubator.apache.org/documentation.html">Apache Olingo Documentation</a> page.</p>
-<h2 id="preparation">Preparation</h2>
-<h3 id="release-manager">Release Manager</h3>
+<h3 id="preparation">Preparation</h3>
+<h4 id="release-manager">Release Manager</h4>
<p>A release manager must be appointed for a release. He or she is in charge of the release process,
following the guidelines and eventually generating the release artifacts.
The release manager might tailor the process for a specific release.</p>
-<h3 id="version">Version</h3>
+<h4 id="version">Version</h4>
<p>The OpenCMIS community decides if the release will be a major or a minor release and
agrees on a version number.</p>
-<h3 id="open-issues">Open Issues</h3>
+<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">versions</span><span class="p">:</span><span class="n">set</span> <span class="o">-</span><span class="n">DnewVersion</span><span class="p">=</span>1<span class="p">.</span>0<span class="p">.</span>0<span class="o">-</span><span class="n">RC01</span>
+<span class="nb">find</span> <span class="p">.</span> <span class="o">-</span><span class="n">name</span> <span class="s">'*.versionsBackup'</span> <span class="o">-</span><span class="n">type</span> <span class="n">f</span> <span class="o">-</span><span class="n">delete</span>
+<span class="n">git</span> <span class="n">add</span> <span class="p">.</span>
+<span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">am</span> <span class="s">'Issue OLINGO-25 - make release - set version 1.0.0-RC01'</span>
+<span class="n">git</span> <span class="n">tag</span> <span class="o">-</span><span class="n">f</span> 1<span class="p">.</span>0<span class="p">.</span>0<span class="o">-</span><span class="n">RC01</span>
+
+<span class="n">mvn</span> <span class="n">versions</span><span class="p">:</span><span class="n">set</span> <span class="o">-</span><span class="n">DnewVersion</span><span class="p">=</span>1<span class="p">.</span>1<span class="p">.</span>0<span class="o">-</span><span class="n">SNAPSHOT</span>
+<span class="nb">find</span> <span class="p">.</span> <span class="o">-</span><span class="n">name</span> <span class="s">'*.versionsBackup'</span> <span class="o">-</span><span class="n">type</span> <span class="n">f</span> <span class="o">-</span><span class="n">delete</span>
+<span class="n">git</span> <span class="n">add</span> <span class="p">.</span>
+<span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">am</span> <span class="s">'Issue OLINGO-25 - make release - set version 1.1.0-SNAPSHOT'</span>
+<span class="n">git</span> <span class="n">push</span>
+<span class="n">git</span> <span class="n">push</span> <span class="o">--</span><span class="n">tags</span>
+</pre></div>
+
+
+<h4 id="open-issues">Open Issues</h4>
<p>There must not be any open JIRA issues for this release. There might be open issues for
future releases. Check with: <a href="https://issues.apache.org/jira/browse/OLINGO/fixforversion/12324804">fix for version view</a></p>
-<h3 id="unit-tests-and-integration-tests">Unit Tests and Integration Tests</h3>
+<h4 id="unit-tests-and-integration-tests">Unit Tests and Integration Tests</h4>
<p>All unit tests and integration tests must succeed on a
clean machine (starting with an empty local Maven repository). The following Maven
execution will run all unit and integration tests:</p>
@@ -138,7 +153,7 @@ execution will run all unit and integrat
</pre></div>
-<h3 id="apache-license-and-code-style">Apache License and Code Style</h3>
+<h4 id="apache-license-and-code-style">Apache License and Code Style</h4>
<p>Each source code file must have a current ASF license header. The source
code should follow the Apache Olingo code style. For verification run following
Maven execution</p>
@@ -146,7 +161,7 @@ Maven execution</p>
</pre></div>
-<h3 id="packaging">Packaging</h3>
+<h4 id="packaging">Packaging</h4>
<p>NOTICE, LICENSE and DISCLAIMER must be present in all bundles and must be up-to-date. </p>
<p>Remote resources are provided by the ASF and the Maven <code>remote-resources-plugin</code> is
configured in the parent pom of the project.</p>
@@ -155,21 +170,43 @@ configured in the parent pom of the proj
</pre></div>
-<h3 id="release-tag">Release Tag</h3>
+<p>The Maven module <code>odata2-dist</code> is responsible to package convenience distribution zip files
+using the assembly plugin. The distributions are created with a release build <code>mvn clean install -Papache-release</code></p>
+<h4 id="md5-and-sha-for-distribution-packages">MD5 and SHA for distribution packages</h4>
+<p>MD5 and SHA files are created manually for distribution packages:</p>
+<div class="codehilite"><pre>openssl md5 <span class="nt">< </span><span class="cp">${</span><span class="n">filename</span><span class="cp">}</span><span class="nt">.zip</span> <span class="nt">></span> <span class="cp">${</span><span class="n">filename</span><span class="cp">}</span>.zip.md5
+gpg --print-md SHA512 <span class="cp">${</span><span class="n">filename</span><span class="cp">}</span>.zip > <span class="cp">${</span><span class="n">filename</span><span class="cp">}</span>.zip.sha
+</pre></div>
+
+
+<h4 id="release-tag">Release Tag</h4>
<p>A tag has to be created for every release candidate. The naming rule
for the tags is olingo-${version}-RCxx. This is created as
part of the Maven release process. The tag will be renamed to the
final version number upon vote approval.</p>
-<h3 id="release-branch">Release Branch</h3>
+<h4 id="release-branch">Release Branch</h4>
<p>A branch has to be created for every release. The naming rule for this
branch is olingo-${version}. This has to be created
manually upon release approval.</p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kd">class</span> <span class="nc">Bla</span> <span class="o">{</span>
-<span class="o">};</span>
-</pre></div>
-
-
-<h2 id="additional-apache-release-information">Additional Apache Release Information</h2>
+<h3 id="release-candidate">Release Candidate</h3>
+<p>Once all preparations are done, a release candidate will be built.</p>
+<p>All release candidates must be cryptographically signed. The string
+"-RCxx" will be attached to the version number of the release candidate
+artifacts, where is the number of the release candidate starting with 01.
+If more than one release candidate is required a new tag has to be created
+and release candidate number will be increased by one.</p>
+<p>The release candidate artifacts:</p>
+<ul>
+<li>Maven artifacts will be staged on repository.apache.org. A new staging repo
+is created per RC and will be communicated upon release.</li>
+<li>Distribution commodity packages are staged at
+http:/people.apache.org/~<username>/olingo/<version></li>
+</ul>
+<p>Once candidate artifacts are available, release manager kicks off the VOTE process.</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 publishing.</p>
+<h3 id="additional-apache-release-information">Additional Apache Release Information</h3>
<ul>
<li><a href="http://www.apache.org/dev/release.html">Releases Policy</a></li>
<li><a href="http://www.apache.org/dev/release-publishing.html">Publishing Releases</a></li>