Author: dennisl
Date: Tue Jul 23 21:17:02 2013
New Revision: 1506286
URL: http://svn.apache.org/r1506286
Log:
Improve plugin retirement process documentation.
Modified:
maven/site/trunk/content/apt/developers/retirement-plan-plugins.apt
Modified: maven/site/trunk/content/apt/developers/retirement-plan-plugins.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/content/apt/developers/retirement-plan-plugins.apt?rev=1506286&r1=1506285&r2=1506286&view=diff
==============================================================================
--- maven/site/trunk/content/apt/developers/retirement-plan-plugins.apt
(original)
+++ maven/site/trunk/content/apt/developers/retirement-plan-plugins.apt Tue Jul
23 21:17:02 2013
@@ -73,6 +73,25 @@ The vote is open for 72 hours.
[ ] -1 No, because...
+-----
+ If the vote is successful, post the result to the dev list and cc the PMC and
+ users list. For instance:
+
++-----
+To: "Maven Developers List" <d...@maven.apache.org>
+Cc: "Maven Users List" <us...@maven.apache.org>
+CC: "Maven Project Management Committee List" <priv...@maven.apache.org>
+Subject: [RESULT] [VOTE] Retire Maven Foo Plugin
+
+Hi,
+
+The vote has passed with the following result:
+
++1 (binding): <<list of names>>
++1 (non binding): <<list of names>>
+
+I will continue with the steps required to retire this plugin.
++-----
+
If the vote passes, make one final release of the plugin before it is
retired. This allows us to make a clean break. The person who wants to retire
a plugin is the one who does the final release. Below you will find the extra
@@ -82,31 +101,31 @@ The vote is open for 72 hours.
* Make the final release
[[1]] Create an issue in JIRA with the issue type "Task" and the summary
- "Retire this plugin", and schedule it for the final release.
+ "Retire this plugin", and schedule it for the final release. If the plugin
+ includes a JIRA report in the generated site, you will need to close this
+ issue before you make the release.
[[1]] Add the description
"This is the final version of this plugin. It has been retired."
to the final version in JIRA.
[[1]] Add a prominent notice on the front page of the plugin's site,
- informing that the plugin is retired. If the plugin is moved elsewhere,
- that should also be added to the plugin's site. (Add notice templates)
-
- [[1]] The final release must remove the "Source Repository" report from the
- site, since the SCM URLs will be changed when the plugin is retired.
+ informing that the plugin is retired. Suggested text:
- Currently this is not possible because all reports are inherited from the
- parent. Here are two possible work-arounds, that unfortunately only work for
- scenario A:
++-----
+Note: This plugin is retired. It is no longer maintained.
++-----
- * Change the SCM URL:s in the <<<pom.xml>>> of the checkout directory
before
- you deploy the site
+ If the plugin is moved elsewhere, that should also be added to the plugin's
+ site. Suggested text:
- * Specify the command line parameters <<<anonymousConnection>>>,
- <<<developerConnection>>> and <<<webAccessUrl>>>, pointing to the new svn
- location when you deploy the site
++-----
+Note: This plugin has retired from the Apache Maven project,
+but has moved to the <Organization> <Project> project.
++-----
- []
+ [[1]] Add " (RETIRED)" at the end of <<<\<project\>>>>/<<<\<name\>>>> in the
+ plugin's <<<pom.xml>>>. This will show up on every page of the generated
site.
[[1]] Go ahead with the standard release process, making sure that you follow
the exceptions mentioned above regarding the site deployment.
@@ -121,6 +140,8 @@ The vote is open for 72 hours.
[[1]] Move the source code in Subversion. Where to depends on which scenario
was decided on.
+ [[1]] Change the SCM URLs in the <<<pom.xml>>> to point to the new location.
+
[[1]] Put the JIRA project in read-only mode. (How to do this?)
[[1]] Update the plugins page, by moving Maven Foo Plugin to under the
