From bca17d6ed891c4a923403a2be69c832e3cba153a Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sun, 16 Oct 2022 19:43:24 +0200 Subject: [PATCH] [MSHARED-1154] Remove announcement templates for not used maven-changes-plugin --- .../org/apache/maven/plugins/announcement.vm | 71 ------------------- .../org/apache/maven/shared/announcement.vm | 71 ------------------- src/site/apt/index.apt.vm | 18 ----- src/site/apt/usage.apt.vm | 39 ++-------- 4 files changed, 6 insertions(+), 193 deletions(-) delete mode 100644 src/main/resources/org/apache/maven/plugins/announcement.vm delete mode 100644 src/main/resources/org/apache/maven/shared/announcement.vm diff --git a/src/main/resources/org/apache/maven/plugins/announcement.vm b/src/main/resources/org/apache/maven/plugins/announcement.vm deleted file mode 100644 index 2e66eea..0000000 --- a/src/main/resources/org/apache/maven/plugins/announcement.vm +++ /dev/null @@ -1,71 +0,0 @@ -## Licensed to the Apache Software Foundation (ASF) under one -## or more contributor license agreements. See the NOTICE file -## distributed with this work for additional information -## regarding copyright ownership. The ASF licenses this file -## to you under the Apache License, Version 2.0 (the -## "License"); you may not use this file except in compliance -## with the License. You may obtain a copy of the License at -## -## http://www.apache.org/licenses/LICENSE-2.0 -## -## Unless required by applicable law or agreed to in writing, -## software distributed under the License is distributed on an -## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -## KIND, either express or implied. See the License for the -## specific language governing permissions and limitations -## under the License. -The Maven team is pleased to announce the release of the ${project.name}, version ${version} - -${introduction} - -${url} - -You should specify the version in your project's plugin configuration: - - - org.apache.maven.plugins - ${artifactId} - ${version} - - - -Release Notes - ${project.name} - Version ${version} -#if ($release.getActions().size() == 0) - -No changes defined in this version. -#else -#if ($release.getActions('fix').size() !=0) - -Bug -#foreach($actionItem in $release.getActions('fix')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -#if ($release.getActions('update').size() !=0) - -Improvement -#foreach($actionItem in $release.getActions('update')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -#if ($release.getActions('add').size() !=0) - -New Feature -#foreach($actionItem in $release.getActions('add')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -#if ($release.getActions('').size() !=0) - -Task -#foreach($actionItem in $release.getActions('')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -## End of main loop -#end - - -Enjoy, - --The Maven team diff --git a/src/main/resources/org/apache/maven/shared/announcement.vm b/src/main/resources/org/apache/maven/shared/announcement.vm deleted file mode 100644 index f5419f4..0000000 --- a/src/main/resources/org/apache/maven/shared/announcement.vm +++ /dev/null @@ -1,71 +0,0 @@ -## Licensed to the Apache Software Foundation (ASF) under one -## or more contributor license agreements. See the NOTICE file -## distributed with this work for additional information -## regarding copyright ownership. The ASF licenses this file -## to you under the Apache License, Version 2.0 (the -## "License"); you may not use this file except in compliance -## with the License. You may obtain a copy of the License at -## -## http://www.apache.org/licenses/LICENSE-2.0 -## -## Unless required by applicable law or agreed to in writing, -## software distributed under the License is distributed on an -## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -## KIND, either express or implied. See the License for the -## specific language governing permissions and limitations -## under the License. -The Maven team is pleased to announce the release of the ${project.name}, version ${version} - -${introduction} - -${url} - -You should specify the version in your project's dependency configuration: - - - org.apache.maven.shared - ${artifactId} - ${version} - - - -Release Notes - ${project.name} - Version ${version} -#if ($release.getActions().size() == 0) - -No changes defined in this version. -#else -#if ($release.getActions('fix').size() !=0) - -Bug -#foreach($actionItem in $release.getActions('fix')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -#if ($release.getActions('update').size() !=0) - -Improvement -#foreach($actionItem in $release.getActions('update')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -#if ($release.getActions('add').size() !=0) - -New Feature -#foreach($actionItem in $release.getActions('add')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -#if ($release.getActions('').size() !=0) - -Task -#foreach($actionItem in $release.getActions('')) -* [$actionItem.getIssue()] $actionItem.getAction() -#end -#end -## End of main loop -#end - - -Enjoy, - --The Maven team diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index 8cbac0d..fb279ba 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -32,24 +32,6 @@ ${project.name} current version (${project.version}) of Maven Shared Resources. They are listed by which plugin they are meant to be used with. - -* Maven Changes Plugin - -** <<>> - - This is a template that can be used by Maven Changes Plugin to create and send - an announcement e-mail for one of our plugins. It will create an announcement - e-mail that conforms to the "Promote the release" section of our - {{{http://maven.apache.org/developers/release/maven-project-release-procedure.html#Promote_the_release}release procedure}}. - -** <<>> - - This is a template that can be used by Maven Changes Plugin to create and send - an announcement e-mail for one of our shared components. It will create an - announcement e-mail that conforms to the "Promote the release" section of our - {{{http://maven.apache.org/developers/release/maven-project-release-procedure.html#Promote_the_release}release procedure}}. - - * Maven Checkstyle Plugin ** <<>> diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm index beb5eec..250b4bd 100644 --- a/src/site/apt/usage.apt.vm +++ b/src/site/apt/usage.apt.vm @@ -25,7 +25,7 @@ Usage - There are a couple things you need to do to use Maven Shared Resources. First + There are a couple of things you need to do to use Maven Shared Resources. First you need to give the plugin that will use the resources access to them. After that you configure the plugin to actually use the resources. @@ -35,7 +35,7 @@ Usage First you add maven-shared-resources as a dependency to a plugin in your <<>>. This is done to give the plugin access to the resources within the maven-shared-resources JAR file. In this example we will use the resources - in Maven Changes Plugin. + in Maven Checkstyle Plugin. +----------+ @@ -44,8 +44,8 @@ Usage org.apache.maven.plugins - maven-changes-plugin - 2.4 + maven-checkstyle-plugin + 3.2.0 ... @@ -72,33 +72,6 @@ Usage Now you can use the resources in the plugin. You can use them as if they existed in your own project, like this: -+----------+ - - ... - - - - org.apache.maven.plugins - maven-changes-plugin - 2.4 - - org/apache/maven/plugins - - - ... - - - ... - - - - - ... - -+----------+ - - or like this: - +----------+ ... @@ -107,7 +80,7 @@ Usage org.apache.maven.plugins maven-checkstyle-plugin - 3.x.x + 3.2.0 config/maven_checks.xml config/maven-header.txt @@ -133,5 +106,5 @@ Usage practical use. +----------+ -mvn changes:announcement-generate +mvn checkstyle:check +----------+