This is an automated email from the ASF dual-hosted git repository.
mbuenger pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push:
new 321bb872 Small additions to retirement plan
321bb872 is described below
commit 321bb872c45f9c422b0dbd5b0416f15a39a60999
Author: Matthias Bünger <buk...@users.noreply.github.com>
AuthorDate: Sun Mar 16 08:10:05 2025 +0100
Small additions to retirement plan
---
content/apt/developers/retirement-plan-plugins.apt | 35 ++++++++++++++++------
.../deploy-component-reference-documentation.apt | 2 ++
.../component-reference-documentation-helper.md | 5 +++-
3 files changed, 32 insertions(+), 10 deletions(-)
diff --git a/content/apt/developers/retirement-plan-plugins.apt
b/content/apt/developers/retirement-plan-plugins.apt
index beabeae3..ef8a6080 100644
--- a/content/apt/developers/retirement-plan-plugins.apt
+++ b/content/apt/developers/retirement-plan-plugins.apt
@@ -131,11 +131,11 @@ but has moved to the <Organization> <Project> project.
making sure that you follow the exceptions mentioned above regarding the
site deployment.
[[1]] When updating the plugins page, move Maven Foo Plugin to under the
- "Retired" heading. Remove the SVN and JIRA links and add
+ "Retired" heading. Remove the SVN/Github and JIRA/Github Issues links and add
the date of retirement.
[[1]] When updating the version in JIRA, do not add Y.Z+1 and make sure you
- remove any future versions.
+ remove any future versions. This needs to be done by PMC members.
* Clean up after the release
@@ -149,26 +149,43 @@ but has moved to the <Organization> <Project> project.
[[1]] When relevant update summary pages for
{{{https://maven.apache.org/plugins/index.html}plugins}} or
{{{https://maven.apache.org/shared/index.html}shared components}}
- [[1]] Add " (RETIRED)" at the end of the project name in JIRA.
+ [[1]] Add " (RETIRED)" at the end of the project name in JIRA. This needs to
be done by PMC members.
[[1]] Put the JIRA project in read-only mode in case of standalone project
(own Jira key): apply Maven Retired Project Permissions Scheme.
(Requires JIRA admin karma: e.g. ask Brian Fox)
[[1]] Comment the
{{{https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool.conf.html}dist-tool
configuration}} entry.
+ Also comment the plugin's entry in the <<<GetPrerequisites.java>>> and
<<<ListBranchesReport>>> files.
[[1]] Remove from <<<Source Repository>>>
- [[A]] {{https://maven.apache.org/scm.html}}
+ [[A]] {{https://maven.apache.org/scm.html}} (includes the plantUML diagram)
[[A]] {{https://github.com/apache/maven-sources}}
[[1]] Remove distribution from current
{{{https://dist.apache.org/repos/dist/release/maven/}dist area}}
- (history remains available in
{{{https://archive.apache.org/dist/maven/}archive}}).
+ (history remains available in
{{{https://archive.apache.org/dist/maven/}archive}}). This needs to be done by
PMC members.
- [[1]] Update board report
+ [[1]] Update board report. This needs to be done by PMC members.
[[1]] 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.
+ announce and users mailing lists. Explain to people what they
+ should do if they would like to continue development of the plugin. Example
for retirement email:
-~~ Insert template for retirement email here
+------
+To: annou...@maven.apache.org, us...@maven.apache.org
+Subject: [ANN] Retirement Maven Foo Plugin
+
+Hi,
+the Maven Foo Plugin has been retired and is no longer maintained.
+We retired it, because there was very little interest by and interaction with
users over the past years.
+
+The retirement vote results can be seen here: [link to mail in mailing list
archive]
+
+If you would like to continue the development of the plugin, you can fork the
plugin using another groupId and artifactId.
+You also need to rename the plugin, for example from "maven-foo-plugin" to
"foo-maven-plugin".
+Feel free to inform others that you continue working on the plugin in a
different place.
+You can write a mail to the users mailing list for that.
+
+-The Apache Maven team
+------
diff --git
a/content/apt/developers/website/deploy-component-reference-documentation.apt
b/content/apt/developers/website/deploy-component-reference-documentation.apt
index 58d15fda..c4ac8c00 100644
---
a/content/apt/developers/website/deploy-component-reference-documentation.apt
+++
b/content/apt/developers/website/deploy-component-reference-documentation.apt
@@ -149,6 +149,8 @@ svnmucc -m "Publish yyy $version documentation" \
cp HEAD xxx-archives/yyy-LATEST xxx/yyy
------------
+ When using windows, replace the <<<\\>>> with <<<^>>> to ensure correct
multiline command execution.
+
* Updating index page in the Maven site
Some component types have an index page refering to each components of the
same type. This is the case for
diff --git
a/content/markdown/developers/website/component-reference-documentation-helper.md
b/content/markdown/developers/website/component-reference-documentation-helper.md
index 8a6d2a3a..ace35655 100644
---
a/content/markdown/developers/website/component-reference-documentation-helper.md
+++
b/content/markdown/developers/website/component-reference-documentation-helper.md
@@ -49,12 +49,15 @@ select component category, then type artifact id and
version to generate svn com
</td></tr>
<tr><td colspan="3">
-<h3>instructions to publish component release documentation</h3>
+<h3>Instructions to publish component release documentation</h3>
<pre id="svnmucc">svnmucc -m "Publish ${artifactId} ${version} documentation" \
-U https://svn.apache.org/repos/asf/maven/website/components \
cp HEAD ${category}-archives/${artifactId}-LATEST${vSuffix}
${category}-archives/${artifactId}-${version} \
rm ${category}/${artifactId}${vSuffix} \
cp HEAD ${category}-archives/${artifactId}-LATEST${vSuffix}
${category}/${artifactId}${vSuffix}</pre>
+
+When using windows, replace the `\` with `^` to ensure correct multiline
command execution.
+
</td></tr>
<tr><td colspan="2"><iframe id="index-page" src="" width="100%"
height="300px"></iframe></td>
