svn commit: r1527534 - /incubator/olingo/site/trunk/content/doc/release.mdtext

[sk...@apache.org]

Author: sklevenz
Date: Mon Sep 30 12:41:17 2013
New Revision: 1527534

URL: http://svn.apache.org/r1527534
Log:
CMS commit to olingo by sklevenz

Modified:
    incubator/olingo/site/trunk/content/doc/release.mdtext

Modified: incubator/olingo/site/trunk/content/doc/release.mdtext
URL: http://svn.apache.org/viewvc/incubator/olingo/site/trunk/content/doc/release.mdtext?rev=1527534&r1=1527533&r2=1527534&view=diff
==============================================================================
--- incubator/olingo/site/trunk/content/doc/release.mdtext (original)
+++ incubator/olingo/site/trunk/content/doc/release.mdtext Mon Sep 30 12:41:17 2013
@@ -18,18 +18,18 @@ Notice:    Licensed to the Apache Softwa
 
 # Apache Olingo Release Documentation
 
-## Introduction
+### Introduction
 
 This document describes the release guidelines for Apache Olingo. It heavily refers 
 to [standard Apache procedures to release](http://maven.apache.org/developers/release/apache-release.html)
  Maven based projects at Apache.
 
-## Build Environments
+### Build Environments
 
 Apache Olingo is built and released with [Maven3](http://maven.apache.org) and uses 
 the <a href="http://svn.apache.org/repos/asf/maven/pom/tags/apache-13/pom.xml">Apache POM version 13</a>.
 
-## Release Artifacts
+### Release Artifacts
 
 An Apache Olingo release consists of:
 
@@ -39,27 +39,29 @@ _org.apache.olingo_ in the [Apache Maven
 In detail, per every module, where applicable, the following artifacts are produced:
    * **Main artifact**: `<artifactId>-<version>.<ext>`
    * **Source artifact**: `<artifactId>-<version>-sources.<ext>`
-   * **Javadoc artifact**: *<artifactId>-<version>-javadoc.<ext>*
+   * **Javadoc artifact**: `<artifactId>-<version>-javadoc.<ext>`
    * **POM**: `<artifactId>-<version>.pom`
 
+
+
   Also the following additional *distribution commodity packages* are
 provided as part of the release:
 
-   *  `org.apache.olingo-olingo.odata2.parent-${version}-source-release.${ext}` <br/> A source-release 
+   *  `org.apache.olingo-olingo-odata2-parent-incubating-${version}-source-release.${ext}` <br/> A source-release 
 bundle containing all files the sources necessary to build all other artifacts. <br/> **Package formats**: zip.
  
-   *  `org.apache.olingo-olingo.odata2.dist-${version}-javadoc.${ext}` <br/> A bundle containing the OData2 core 
+   *  `org.apache.olingo-olingo-odata2-dist-incubating-${version}-javadoc.${ext}` <br/> A bundle containing the OData2 core 
 library and dependencies required to implement an OData V2 processor. <br/> **Package formats**: zip.
 
-   *  `org.apache.olingo-olingo.odata2.dist-${version}-lib.${ext}` <br/> A bundle 
+   *  `org.apache.olingo-olingo-odata2-dist-incubating-${version}-lib.${ext}` <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/> **Package formats**: zip.
 
-   *  `org.apache.olingo-olingo.odata2.dist-${version}-jpa.${ext}` <br/> A bundle containing the OData2 JPA 
+   *  `org.apache.olingo-olingo-odata2-dist-incubating-${version}-jpa.${ext}` <br/> A bundle containing the OData2 JPA 
 processor and dependencies required to implement an OData V2 processor. <br/> **Package formats**: zip.
 
-   *  `org.apache.olingo-olingo.odata2.dist-${version}-ref.${ext}` <br/> A bundle containing ready-to-depoly WAR 
+   *  `org.apache.olingo-olingo-odata2-dist-incubating-${version}-ref.${ext}` <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/> **Package formats**: zip.
 
 ## Documentation and JavaDoc
@@ -68,25 +70,39 @@ The documentation that will be part of t
 All examples in the documentation must work. The Java package documentation must be 
 up-to-date. Release independend documentation is maintained on the [Apache Olingo Documentation][1] page.
 
-## Preparation
+### Preparation
 
-### Release Manager
+#### Release Manager
 
 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.
 
-### Version
+#### Version
 
 The OpenCMIS community decides if the release will be a major or a minor release and 
 agrees on a version number.
 
-### Open Issues
+    mvn versions:set -DnewVersion=1.0.0-RC01
+    find . -name '*.versionsBackup' -type f -delete
+    git add .
+    git commit -am 'Issue OLINGO-25 - make release - set version 1.0.0-RC01'
+    git tag -f 1.0.0-RC01
+    
+    mvn versions:set -DnewVersion=1.1.0-SNAPSHOT
+    find . -name '*.versionsBackup' -type f -delete
+    git add .
+    git commit -am 'Issue OLINGO-25 - make release - set version 1.1.0-SNAPSHOT'
+    git push
+    git push --tags
+
+
+#### Open Issues
 
 There must not be any open JIRA issues for this release. There might be open issues for 
 future releases. Check with: [fix for version view][2]
 
-### Unit Tests and Integration Tests
+#### Unit Tests and Integration Tests
 
 All unit tests and integration tests must succeed on a 
 clean machine (starting with an empty local Maven repository). The following Maven 
@@ -94,7 +110,7 @@ execution will run all unit and integrat
 
     mvn clean install
 
-### Apache License and Code Style
+#### Apache License and Code Style
 
 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
@@ -102,7 +118,7 @@ Maven execution
 
     mvn clean install -Pbuild.quality
  
-### Packaging
+#### Packaging
 
 NOTICE, LICENSE and DISCLAIMER must be present in all bundles and must be up-to-date. 
 
@@ -113,25 +129,55 @@ configured in the parent pom of the proj
     <resourceBundle>org.apache:apache-jar-resource-bundle:1.4</resourceBundle>
     <resourceBundle>org.apache:apache-incubator-disclaimer-resource-bundle:1.1</resourceBundle>
   
-### Release Tag
+The Maven module `odata2-dist` is responsible to package convenience distribution zip files 
+using the assembly plugin. The distributions are created with a release build `mvn clean install -Papache-release`
+
+#### MD5 and SHA for distribution packages
+
+MD5 and SHA files are created manually for distribution packages:
+
+    openssl md5 < ${filename}.zip > ${filename}.zip.md5
+    gpg --print-md SHA512 ${filename}.zip > ${filename}.zip.sha
+ 
+
+#### Release Tag
 
 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.
 
-### Release Branch
+#### Release Branch
 
 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.
 
-    :::java
-    public class Bla {
-    };
+### Release Candidate
+
+Once all preparations are done, a release candidate will be built.
+
+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.
+
+The release candidate artifacts:
+
+  - Maven artifacts will be staged on repository.apache.org. A new staging repo 
+is created per RC and will be communicated upon release.
+  - Distribution commodity packages are staged at 
+http:/people.apache.org/~<username>/olingo/<version>
+
+Once candidate artifacts are available, release manager kicks off the VOTE process.
+
+If the vote fails, the raised issues will be fixed, a new release candidate will be 
+built and the VOTE process will be restarted.
 
+If the release candidate gets approved, we can proceed to release publishing.
 
-## Additional Apache Release Information
+### Additional Apache Release Information
 
   - [Releases Policy][3]
   - [Publishing Releases][4]
@@ -144,4 +190,4 @@ manually upon release approval.
   [3]: http://www.apache.org/dev/release.html
   [4]: http://www.apache.org/dev/release-publishing.html
   [5]: http://www.apache.org/dev/publishing-maven-artifacts.html
-  [6]: http://incubator.apache.org/guides/releasemanagement.html
\ No newline at end of file
+  [6]: http://incubator.apache.org/guides/releasemanagement.html