You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2011/05/23 23:39:25 UTC

svn commit: r1126764 - in /maven/site/trunk/src/site/apt/developers: committer-settings.apt release/maven-project-release-procedure.apt

Author: dennisl
Date: Mon May 23 21:39:24 2011
New Revision: 1126764

URL: http://svn.apache.org/viewvc?rev=1126764&view=rev
Log:
Document how to use Maven Changes Plugin to generate and send out release announcements for plugins.

Modified:
    maven/site/trunk/src/site/apt/developers/committer-settings.apt
    maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt

Modified: maven/site/trunk/src/site/apt/developers/committer-settings.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/committer-settings.apt?rev=1126764&r1=1126763&r2=1126764&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/developers/committer-settings.apt (original)
+++ maven/site/trunk/src/site/apt/developers/committer-settings.apt Mon May 23 21:39:24 2011
@@ -2,8 +2,9 @@
  Developers centre - Committer Settings
  ------
  Vincent Siveton
+ Dennis Lundberg
  ------
- October 2006
+ 2011-05-23
  ------
 
 ~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -30,7 +31,7 @@ Introduction
 
  This document is intended to set up the Maven committer settings, i.e. the <<<$\{user.home\}/.m2/settings.xml>>>.
 
-Enable Apache Servers
+* Enable Apache Servers
 
  Maven uses several servers configuration to deploy snapshots, releases and documentation on the Apache servers.
  You need to tell to Maven what your Apache username is. Please note that the servers now use your LDAP credentials,
@@ -40,7 +41,7 @@ Enable Apache Servers
 
 +-----+
 <settings>
-...
+  ...
   <servers>
     <!-- To publish a snapshot of some part of Maven -->
     <server>
@@ -74,3 +75,25 @@ Enable Apache Servers
 +-----+
 
  You also need to be a member of the group <<<apcvs>>> and <<<maven>>> on <<<people.apache.org>>>.
+
+ 
+* Enable sending announcement e-mails
+
+ To be able to send out announcements of Maven releases you need to add a couple
+ of properties to the <<<apache-release>>> profile.
+
++-----+
+<settings>
+  ...
+  <profiles>
+    <profile>
+      <id>apache-release</id>
+      <properties>
+        <apache.availid> <!-- YOUR APACHE LDAP USERNAME --> </apache.availid>
+        <smtp.host> <!-- YOUR SMTP SERVER --> </smtp.host>
+      </properties>
+    </profile>
+    ...
+  </profiles>
+</settings>
++-----+

Modified: maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt?rev=1126764&r1=1126763&r2=1126764&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt (original)
+++ maven/site/trunk/src/site/apt/developers/release/maven-project-release-procedure.apt Mon May 23 21:39:24 2011
@@ -156,10 +156,31 @@ I will promote the artifacts to the cent
  the <<<Y.Z>>> version as released. Create version <<<Y.Z+1>>>, if that hasn't already
  been done. You may also archive any deprecated releases (milestones or alphas) at this time.
 
- [[4]] Create an announcement. For instance, for Maven:
+ [[4]] Create an announcement.
 
- <<Note:>> You must send this email from your apache email account, e.g. YOUR_APACHE_USERNAME@apache.org otherwise
- the email to announce@maven.apache.org will bounce.
+   [[a]] Using Maven Changes Plugin
+
+   For a plugin release you can let Maven Changes Plugin generate and send the
+   announcement for you. First make sure that you have configured the necessary
+   properties in your {{{../committer-settings.html}committer settings}}.
+
++------+
+cd target/checkout
+mvn changes:announcement-mail -Papache-release
++------+
+
+   If your SMTP server requires authentication you need to add the command line
+   options for it:
+ 
++------+
+cd target/checkout
+mvn changes:announcement-mail -Dchanges.username=<SMTP-USERNAME> -Dchanges.password=<SMTP-PASSWORD> -Papache-release
++------+
+
+   [[b]] Manually
+    
+   <<Note:>> You must send this email from your apache email account, e.g. YOUR_APACHE_USERNAME@apache.org otherwise
+   the email to announce@maven.apache.org will bounce.
 
 +-----+
 From: YOUR_APACHE_USERNAME@apache.org
@@ -191,6 +212,8 @@ Enjoy,
 
 +-----+
 
+   []
+
  [[5]] Add the release to the next board report, in the private subversion area.
 
  This is a PMC activity.  If you are not a PMC member then email the Developer's