You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2014/10/25 11:45:57 UTC
svn commit: r1634199 -
/mina/site/trunk/content/mina-project/developper-guide.mdtext
Author: elecharny
Date: Sat Oct 25 09:45:57 2014
New Revision: 1634199
URL: http://svn.apache.org/r1634199
Log:
Updated the release documentation
Modified:
mina/site/trunk/content/mina-project/developper-guide.mdtext
Modified: mina/site/trunk/content/mina-project/developper-guide.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/developper-guide.mdtext?rev=1634199&r1=1634198&r2=1634199&view=diff
==============================================================================
--- mina/site/trunk/content/mina-project/developper-guide.mdtext (original)
+++ mina/site/trunk/content/mina-project/developper-guide.mdtext Sat Oct 25 09:45:57 2014
@@ -197,14 +197,6 @@ Answer to maven questions :
<either use the default version as suggested, or type in the version you@qot;d like to be used>
[..]
-<DIV class="info" markdown="1">
-Just after the last module, maven will ask you about the SCM tag :
-
- What is SCM release tag or label for "Apache MINA"? (org.apache.mina:mina-parent) mina-parent-2.0.7: : 2.0.7
-
-Do **not** type <enter> to select the default value. Instead, type the correct version.
-</DIV>
-
Then some other questions will be asked, about the next version to use. The default values should be fine.
<DIV class="info" markdown="1">
@@ -212,12 +204,6 @@ Then some other questions will be asked,
Make sure the change made by the release plugin is correct! (pom.xml, tags created)
</DIV>
-
-Now, you have to build the project :
-
- $ mvn clean install -Pserial
-
-It should not be a necessay step, but at the moment, we have an issue with the Javadoc plugin which requires the modules to have been built before running the release.
### Step 3 : Processing with the real release
When the dry run is successful, then you can do in real with the following commands:
@@ -229,43 +215,12 @@ The first step will clean up the local s
At some point, it will ask for your passphrase (the one you used when you created your PGP key). Type it in.
-At the end, if you proceed the release on a Mac, you may get the following message :
-
- [INFO] Tagging release with the label 2.0.7...
- [INFO] Executing: /bin/sh -c cd /Users/elecharny/mina/trunk && svn --non-interactive
- copy --file /var/folders/t7/t7UwkHaiGleYYgPqGZTbF++++TM/-Tmp-/maven-scm-409730412.commit
- --revision XXXXX https://svn.apache.org/repos/asf/mina/trunk
- https://svn.apache.org/repos/asf/mina/tags/2.0.7
- [INFO] Working directory: /Users/elecharny/mina/trunk
- [INFO] ------------------------------------------------------------------------
- [ERROR] BUILD FAILURE
- [INFO] ------------------------------------------------------------------------
- [INFO] Unable to tag SCM
- Provider message:
- The svn tag command failed.
- Command output:
- svn: No such revision XXXXX
-
-If so, just type the two following commands :
-
- $ svn up -r HEAD
- At revision YYYYYY.
- $ mvn -Pserial,apache-release release:prepare -Dresume
- ...
- [INFO] Release preparation complete.
- [INFO] ------------------------------------------------------------------------
- [INFO] BUILD SUCCESSFUL
- [INFO] ------------------------------------------------------------------------
- [INFO] Total time: 1 minute 4 seconds
- [INFO] Finished at: Mon Sep 13 16:12:02 CEST 2010
- [INFO] Final Memory: 28M/81M
- [INFO] ------------------------------------------------------------------------
Three mails will be generated, and sent to commits@mina.apache.org :
- svn commit: r996535 - in /mina/trunk: ./ distribution/ mina-core/ mina-example/ mina-filter...
- svn commit: r996542 - /mina/tags/2.0.7/
- svn commit: r996544 - in /mina/trunk: ./ distribution/ mina-core/ mina-example/ mina-filter...
+ git commit: [maven-release-plugin] prepare release 2.0.9
+ Git Push Summary
+ git commit: [maven-release-plugin] prepare for next development iteration
The first mail tells you that the SNAPSHOT has been moved to the release version in trunk, the second mails tells you that this version has been tagged, and the last mail tells you that trunk has moved to the next version.
@@ -324,8 +279,6 @@ Connect to the Nexus server (https://rep
This creates the site.
-<DIV class="info" markdown="1">
-
### Step 7 : Sign the packages
Now, you have to sign the binary packages which are in target/checkout/distribution/target.
@@ -353,9 +306,10 @@ You'll get something like :
Take the <zzzzzzzz> part of your 4096 bit key.
+Use a shell script to sign the packages which are stored in target/checkout/distribution/target. You will first have to delete the created .asc files :
-Use a shell script to sign the packages which are stored in target/checkout/distribution/target :
-
+7C6B7034
+ localhost:target elecharny$ rm *.asc
localhost:target elecharny$ ~/sign.sh
PGP Key ID:
<your PGP key>
@@ -432,44 +386,44 @@ First of all, create a new directory on
Then copy the packages :
- $ cd distributions/target
- $ scp apache-mina-<version>-* people.apache.org:public_html/mina/
+ $ cd target/checkout/distributions/target
+ $ scp apache-mina-<version>-* people.apache.org:public_html/mina-<version>/
Update your index.html file on people.apach.org/public_html to make the packages visible. Here is an example of possible content :
<h2>Last MINA 2.0.9 tarballs</h2>
<h3>Sources</h3>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.gz">apache-mina-2.0.9-src.tar.gz</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.asc</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.md5</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.sha1</a><br/>
-
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.bz2">apache-mina-2.0.9-src.tar.bz2</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.asc</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.md5</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.sha1</a><br/>
-
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.zip">apache-mina-2.0.9-src.zip</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.asc</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.md5</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.sha1</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz">apache-mina-2.0.9-src.tar.gz</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.asc</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.md5</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.gz.asc">apache-mina-2.0.9-src.tar.gz.sha1</a><br/>
+
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2">apache-mina-2.0.9-src.tar.bz2</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.asc</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.md5</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.tar.bz2.asc">apache-mina-2.0.9-src.tar.bz2.sha1</a><br/>
+
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip">apache-mina-2.0.9-src.zip</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.asc</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.md5</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-src.zip.asc">apache-mina-2.0.9-src.zip.sha1</a><br/>
<h3>Binaries</h3>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.gz">apache-mina-2.0.9-bin.tar.gz</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.asc</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.md5</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.sha1</a><br/>
-
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.bz2">apache-mina-2.0.9-bin.tar.bz2</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.asc</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.md5</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.sha1</a><br/>
-
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.zip">apache-mina-2.0.9-bin.zip</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.asc</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.md5</a><br/>
- <img src="/icons/compressed.gif" alt="[ ]"><a href="mina/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.sha1</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz">apache-mina-2.0.9-bin.tar.gz</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.asc</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.md5</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.gz.asc">apache-mina-2.0.9-bin.tar.gz.sha1</a><br/>
+
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2">apache-mina-2.0.9-bin.tar.bz2</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.asc</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.md5</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.tar.bz2.asc">apache-mina-2.0.9-bin.tar.bz2.sha1</a><br/>
+
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip">apache-mina-2.0.9-bin.zip</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.asc</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.md5</a><br/>
+ <img src="/icons/compressed.gif" alt="[ ]"><a href="mina-2.0.9/apache-mina-2.0.9-bin.zip.asc">apache-mina-2.0.9-bin.zip.sha1</a><br/>
### Step 9 : Test the New Version with FtpServer, Sshd and Vysper
@@ -528,11 +482,70 @@ You can officially close the vote now. T
* Release the project on https://repository.apache.org
* Copy the tarballs and heir signature in people.apache.org /www/www.apache.org/dist/mina
+This can be done on people.apache.org :
+
+ $ ssh people.apache.org
+ # svn co https://dist.apache.org/repos/dist/release/mina/mina/ mina-dist
+ # cd mina-dist
+ # mkdir <version>
+ # cp ../public_html/mina-<version>/* <version>
+ # svn add <version>
+ # svn ci <version>
+ ...
+ # exit
+ $
+
### Step 12: Deploy Web Reports (JavaDoc and JXR)
- $ svn co https://svn.apache.org/repos/asf/mina/mina/tags/<version> mina
- $ cd mina
- $ mvn -Pserial clean compile site site:deploy
+The javadoc and xref files have been generated in step 6, it's now time to push them into the production site. They are generated in the following directory :
+
+ target/checkout/target/site
+
+We will copy two directories :
+
+ apidocs
+ xref
+
+Staging or Production?
+
+
+<DIV class="info" markdown="1">
+Those files will be stored on the production server only !!! And some extra caution ust be taken not to delete them when we will publish the staging site too...
+</DIV>
+
+First of all, you must checkout the two CMS store for the site : staging and production.
+
+ $ svn co https://svn.apache.org/repos/infra/websites/staging/mina/trunk staging
+ ...
+ $ svn co https://svn.apache.org/repos/infra/websites/production/mina production
+ ...
+
+Then copy the generated docs :
+
+ $ cp -r ~/mina/target/checkout/target/site/apidocs production/content/mina/mina-project/
+ $ cp -r ~/mina/target/checkout/target/site/xref production/content/mina/mina-project/
+ $
+
+You have to check in those directories :
+
+ $ svn add apidocs
+ $ svn add xref
+ $ svn ci apidocs xref -m "Injected MINA <version> javadocs"
+
+Now, you have to update the staging site <em>extpaths.txt</em>
+
+This file list the file on the production site that will not be overriden by the publication of the staging site. It has to be updated
+
+ $ cd ~/apacheds/staging/content/
+ $ vi extpaths.txt
+
+The following lines should be present. If not, add them and commit the file :
+
+ mina-project/apidocs
+ mina-project/testapidocs
+ mina-project/xref
+ mina-project/xref-test
+ ...
### Step 13: Wait 24 hours