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:42:48 UTC
svn commit: r1084361 -
/chemistry/site/trunk/content/internal/opencmis-maven-release-documentation.mdtext
Author: gabriele
Date: Tue Mar 22 21:42:48 2011
New Revision: 1084361
URL: http://svn.apache.org/viewvc?rev=1084361&view=rev
Log:
updated release docs as per CMIS-305
Modified:
chemistry/site/trunk/content/internal/opencmis-maven-release-documentation.mdtext
Modified: chemistry/site/trunk/content/internal/opencmis-maven-release-documentation.mdtext
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/internal/opencmis-maven-release-documentation.mdtext?rev=1084361&r1=1084360&r2=1084361&view=diff
==============================================================================
--- chemistry/site/trunk/content/internal/opencmis-maven-release-documentation.mdtext (original)
+++ chemistry/site/trunk/content/internal/opencmis-maven-release-documentation.mdtext Tue Mar 22 21:42:48 2011
@@ -1,24 +1,7 @@
Title: OpenCMIS Maven Release Documentation
Breadcrumb: opencmis:OpenCMIS
-* [OpenCMIS Release Documentation](#OpenCMISMavenReleaseDocumentation-OpenCMISReleaseDocumentation)
- * [Introduction](#OpenCMISMavenReleaseDocumentation-Introduction)
- * [Build Environments](#OpenCMISMavenReleaseDocumentation-BuildEnvironments)
- * [Release Artifacts](#OpenCMISMavenReleaseDocumentation-ReleaseArtifacts)
- * [Documentation and JavaDoc](#OpenCMISMavenReleaseDocumentation-DocumentationandJavaDoc)
- * [Preparation](#OpenCMISMavenReleaseDocumentation-Preparation)
- * [Release Manager](#OpenCMISMavenReleaseDocumentation-ReleaseManager)
- * [Version](#OpenCMISMavenReleaseDocumentation-Version)
- * [Open Issues](#OpenCMISMavenReleaseDocumentation-OpenIssues)
- * [Unit Tests and Integration Tests](#OpenCMISMavenReleaseDocumentation-UnitTestsandIntegrationTests)
- * [Apache License and Code Style](#OpenCMISMavenReleaseDocumentation-ApacheLicenseandCodeStyle)
- * [Release Notes](#OpenCMISMavenReleaseDocumentation-ReleaseNotes)
- * [Release Tag](#OpenCMISMavenReleaseDocumentation-ReleaseTag)
- * [Release Branch](#OpenCMISMavenReleaseDocumentation-ReleaseBranch)
- * [Release Candidate](#OpenCMISMavenReleaseDocumentation-ReleaseCandidate)
- * [Publishing The Release](#OpenCMISMavenReleaseDocumentation-PublishingTheRelease)
- * [Post Release Cleanup](#OpenCMISMavenReleaseDocumentation-PostReleaseCleanup)
-
+[TOC]
<a name="OpenCMISMavenReleaseDocumentation-OpenCMISReleaseDocumentation"></a>
# OpenCMIS Release Documentation
@@ -27,58 +10,52 @@ Breadcrumb: opencmis:OpenCMIS
This document describes the release process for Apache Chemistry OpenCMIS.
It heavily refers to [standard Apache procedures to release](http://maven.apache.org/developers/release/apache-release.html)
- Maven based projects at Apache. Also [general incubator best practices|http://incubator.apache.org/guides/releasemanagement.html]
- have been implemented.
+ Maven based projects at Apache.
<a name="OpenCMISMavenReleaseDocumentation-BuildEnvironments"></a>
## Build Environments
-OpenCMIS is built and released with [Maven2](http://maven.apache.org)
- and uses the [Apache POM version 7|http://svn.apache.org/repos/asf/maven/pom/tags/apache-7/pom.xml]
- .
-
+OpenCMIS is built and released with [Maven2](http://maven.apache.org) and uses the <a href="http://svn.apache.org/repos/asf/maven/pom/tags/apache-9/pom.xml">Apache POM version 9</a>.
<a name="OpenCMISMavenReleaseDocumentation-ReleaseArtifacts"></a>
## Release Artifacts
-An OpenCMIS release ([see an exampled of all released packages here](https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~0.1.0-incubating-SNAPSHOT)
-) consists of:
+An OpenCMIS release ([see an exampled of all released packages here](https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~0.3.0-SNAPSHOT)) consists of:
-* All POMs/JARs/WARs built as part of the standard Maven build process. For
+ * All POMs/JARs/WARs built as part of the standard Maven build process. For
an overview on the released modules see artifacts with groupId
-_org.apache.chemistry.opencmis_ in the [Apache Maven Repository](https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~~~)
-. In detail, per every module, where applicable, the following artifacts
+_org.apache.chemistry.opencmis_ in the [Apache Maven Repository](https://repository.apache.org/index.html#nexus-search;gav~org.apache.chemistry.opencmis~~~~). 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>*
-** *POM*: *<artifactId>-<version>.pom*
-
-* Also the following additional *distribution commodity packages* are
+ * **Main artifact**: `<artifactId>-<version>.<ext>`
+ * **Source artifact**: `<artifactId>-<version>-sources.<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:
-** A source-release bundle containing all files the sources necessary to
-build all other artifacts.
-*** *Package formats*: zip.
-*** *Name*: *chemistry-opencmis-<version>-source-release.<ext>*
-** A package containing offline HTML documentation and the full javadocs:
-*** *Package formats*: tar.gz and zip.
-*** *Name*: *chemistry-opencmis-<version>-docs.<ext>*
-** A client distribution bundle with all the client related JARs:
-*** *Package formats*: tar.gz and zip.
-*** *Name*: *chemistry-opencmis-dist-<version>-client.<ext>*
-** A client bundle (as above) with OpenCMIS Client JARs and all
-dependencies.
-*** *Package formats*: tar.gz and zip.
-*** *Name*:
-*chemistry-opencmis-client-impl-<version>-with-dependencies.<ext>*
-** A bundle containing the OpenCMIS server WARs and support
-*** *Package formats*: tar.gz and zip.
-*** *Name*: *chemistry-opencmis-dist-<version>-server.<ext>*
-** A bundle containing all OpenCMIS server related WARs (_inmemory,
-fileshare, browser)_
-*** *Package formats*: tar.gz and zip.
-*** *Name*: *chemistry-opencmis-dist-<version>-server-webapps.<ext>*
+ * `chemistry-opencmis-<version>-source-release.<ext>` <br/> A source-release bundle containing all files the sources necessary to
+build all other artifacts. **Package formats**: zip.
+ * `chemistry-opencmis-dist-<version>-docs.<ext>` <br/>
+ A package containing offline HTML documentation and the full javadocs for the latest release.
+**Package formats**: tar.gz and zip.
+ * `chemistry-opencmis-dist-<version>-client.<ext>` <br/>
+ A client distribution bundle with all the client related JARs.
+**Package formats**: tar.gz and zip.
+ * `chemistry-opencmis-client-impl-<version>-with-dependencies.<ext>` <br/>
+ A client bundle (as above) with OpenCMIS Client JARs and all
+dependencies.
+**Package formats**: tar.gz and zip.
+ * `chemistry-opencmis-server-support-<version>.<ext>` <br/>
+ A WAR bundle containing the OpenCMIS server support
+**Package formats**: WAR;
+ * `chemistry-opencmis-dist-<version>-server-webapps.<ext>` <br/>
+ A bundle containing all OpenCMIS server related WARs (inmemory,
+fileshare, browser)
+**Package formats**: tar.gz and zip;
+ * `chemistry-opencmis-workbench-<version>-full.<ext>` <br/>
+ ZIP/Tar.gz bundles containing OpenCMIS workbench client application
+**Package formats**: tar.gz and zip;
<a name="OpenCMISMavenReleaseDocumentation-DocumentationandJavaDoc"></a>
#### Documentation and JavaDoc
@@ -88,10 +65,12 @@ examples in the documentation must work.
must be up-to-date. The JavaDoc must be generated with Maven without
warnings.
-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> ([see an example](http://people.apache.org/~gabriele/chemistry/opencmis/0.1.0-incubating-SNAPSHOT/)
-) .
-Later, upon release approval, this will be synced in a sub folder of [http://incubator.apache.org/chemistry/](http://incubator.apache.org/chemistry/)
- and linked from the wiki home page. This will allow to publish up to date
+The Maven site documentation will be generated as part of the release and deployed as part of the vote
+at <p> `http:/people.apache.org/~gabriele/opencmis/<version>` </p> (see <a href="http://people.apache.org/~gabriele/chemistry/opencmis/0.3.0-dryrun/">example</a> here).
+
+Later, upon release approval, this will be synced in the per release sub folder
+<p>`http://chemistry.apache.org/java/<version>/maven`</p>
+and linked from the wiki home page. This will allow to publish up to date
Java Doc and test reports.
<a name="OpenCMISMavenReleaseDocumentation-Preparation"></a>
@@ -135,15 +114,10 @@ code should follow the OpenCMIS code sty
<a name="OpenCMISMavenReleaseDocumentation-ReleaseNotes"></a>
-### Release Notes
+### Packaging
-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.
+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.
<a name="OpenCMISMavenReleaseDocumentation-ReleaseTag"></a>
@@ -175,16 +149,14 @@ has to be created and release candidate
The release candidate artifacts:
-* *Maven artifacts* will be [staged](http://incubator.apache.org/guides/releasemanagement.html)
- on *repository.apache.org*
-* *Distribution commodity packages* are staged
-at {color:#003366}http:/people.apache.org/~_<username>_/opencmis/<version>/dist/{color}
-* The *generated site reports/javadocs* will be staged
-at {color:#003366}http:/people.apache.org/~_<username>_/opencmis/<version>/site/{color}
-
-Once candidate artifacts are available, release manager kicks off the [VOTE process](http://incubator.apache.org/guides/releasemanagement.html#best-practice-incubator-release-vote)
-.
+* **Maven artifacts** will be <a href="http://.apache.org/guides/releasemanagement.html">staged</a>
+ on `repository.apache.org`. A new staging repo is created per RC and will be communicated upon release.
+* **Distribution commodity packages** are staged
+at <br/> `http:/people.apache.org/~<username>/opencmis/<version>/dist/`
+* The **generated site reports/javadocs** will be staged
+at <br/> `http:/people.apache.org/~<username>/opencmis/<version>/site/`
+Once candidate artifacts are available, release manager kicks off the [VOTE process](http://incubator.apache.org/guides/releasemanagement.html#best-practice-incubator-release-vote).
If the vote fails, the raised issues will be fixed, a new release candidate
will be built and the VOTE process will be restarted.
@@ -199,27 +171,23 @@ publishing.
If the release candidate gets approved, we can proceed to release
publishing:
-* *release candidate maven artifacts* are _promoted_ as in the Apache
+* **release candidate maven artifacts** are *promoted* in the Apache
Maven Repository and made available at [https://repository.apache.org/content/groups/public/org/apache/chemistry/](https://repository.apache.org/content/groups/public/org/apache/chemistry/)
- - Maven artifacts are automatically synced to Maven Central [http://repo1.maven.org/maven2]
-
-* *release candidate commodity packages* are synced (together with their
-checksum and signatures) to [http://www.apache.org/dist/incubator/chemistry](http://www.apache.org/dist/incubator/chemistry)
-* *maven site* is synced to [http://incubator.apache.org/chemistry/maven-site/<version>](http://incubator.apache.org/chemistry/maven-site/<version>)
+ - Maven artifacts are automatically synced to Maven Central at `http://repo1.maven.org/maven2/org/apache/chemistry`
+* **release candidate commodity packages** are synced (together with their
+checksum and signatures) to `http://www.apache.org/dist/chemistry`
+* **maven site** is synced to `http://chemistry.apache.org/java/<version>/maven`
and back-linked from [http://incubator.apache.org/chemistry/index.html]
-* *project version* at [http://incubator.apache.org/chemistry/index.html](http://incubator.apache.org/chemistry/index.html)
+* *project version* at [http://chemistry.apache.org/java/opencmis.html](http://incubator.apache.org/chemistry/index.html)
is updated
* *release tag is renamed* to final version
* release branch is created
-* *Release is closed* in [](https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310936)
-* *Release is announced* to
-
-* {noformat}
-general@incubator.apache.org chemistry-dev@incubator.apache.org
+* *Release is closed* in <a href="https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310936">Jira</a>
+* *Release is announced* to `dev@chemistry.apache.org, announce@apache.org`
-
h2. Post Release Cleanup
- * Remove release candidate artifacts and sites
+* Remove release candidate artifacts and sites
+