Retirement Plan for Plugins

Decide to retire

Propose a vote on the dev-list to retire a plugin. The vote should be open for the standard 72 hours to allow people to voice their opinions. Send a cc to the users-list. Standard Apache voting rules apply. Only PMC votes are binding.

The vote must contain one or more options on how to retire the plugin. There are multiple scenarios available. Here are a couple that have been suggested:

  1. Move to our retired area in svn
  2. Move to another Apache project
  3. Move to mojo.codehaus.org, apache-extras.org or another forge

Here's a template for scenario A that can be used for the vote email:

To: "Maven Developers List" <dev@maven.apache.org>
Cc: "Maven Users List" <users@maven.apache.org>
Subject: [VOTE] Retire Maven Foo Plugin

Hi,

A paragraph giving the reasons why the plugin should be retired. Make a note of
how long it has been since the latest release.

I therefor propose that we retire maven-foo-plugin.

If this vote is successful I will make one final release of the plugin, making
it clear on the plugin site that it has been retired. After that the source code
will be moved into the "retired" area in Subversion.

The process for retiring a plugin is described here:
https://maven.apache.org/developers/retirement-plan-plugins.html

The vote is open for 72 hours.

[ ] +1 Yes, it's about time
[ ] -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" <dev@maven.apache.org>
Cc: "Maven Users List" <users@maven.apache.org>
CC: "Maven Project Management Committee List" <private@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 (with its own standard 72h vote on source release) 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 steps that you need to follow when retiring a plugin, in addition to our standard release process.

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. If the plugin includes a JIRA report in the generated site, you will need to close this issue before you make the release.
  2. Add the description "This is the final version of this plugin. It has been retired." to the final version in JIRA.
  3. Add a prominent notice on the front page of the plugin's site, informing that the plugin is retired. Suggested text: 
    Note: This plugin is retired. It is no longer maintained.

    If the plugin is moved elsewhere, that should also be added to the plugin's site. Suggested text:

    Note: This plugin has retired from the Apache Maven project,
but has moved to the <Organization> <Project> project.
  4. 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.
  5. Go ahead with the standard release process, making sure that you follow the exceptions mentioned above regarding the site deployment.
  6. When updating the plugins page, move Maven Foo Plugin to under the "Retired" heading. Remove the SVN and JIRA links and add the date of retirement.
  7. When updating the version in JIRA, do not add Y.Z+1 and make sure you remove any future versions.

Clean up after the release

  1. Remove the plugin from the <modules> section of the plugins aggregator POM.
  2. Remove any jobs from Continuous Integration servers like ASF Jenkins farm. Plugins normally don't have separate jobs, but check anyway just to make sure.
  3. Move the source code in Subversion. Where to depends on which scenario was decided on.
  4. Change the SCM URLs in the pom.xml to point to the new location.
  5. Add " (RETIRED)" at the end of the project name in JIRA.
  6. Put the JIRA project in read-only mode. (How to do this? Probably require JIRA admin karma: ask Brian Fox)
  7. Comment the dist-tool configuration entry.
  8. Remove distribution from current dist area (history remains available in archive).
  9. Announce the fact that the plugin has been retired/moved on the announce@m.a.o and users@m.a.o mailing lists. Explain to people what they should do if they would like to continue development of the plugin.