Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MSHARED-1154] Remove announcement templates for not used m-changes-plugin #4

Merged
merged 1 commit into from
Oct 26, 2022
Merged

[MSHARED-1154] Remove announcement templates for not used m-changes-plugin #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 0 additions & 71 deletions src/main/resources/org/apache/maven/plugins/announcement.vm
View file
Open in desktop

This file was deleted.

71 changes: 0 additions & 71 deletions src/main/resources/org/apache/maven/shared/announcement.vm
View file
Open in desktop

This file was deleted.

18 changes: 0 additions & 18 deletions src/site/apt/index.apt.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

** <<<org/apache/maven/plugins/announcement.vm>>>

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}}.

** <<<org/apache/maven/shared/announcement.vm>>>

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

** <<<config/maven-header.txt>>>
Expand Down
39 changes: 6 additions & 33 deletions src/site/apt/usage.apt.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -35,7 +35,7 @@ Usage
First you add maven-shared-resources as a dependency to a plugin in your
<<<pom.xml>>>. 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.

+----------+
<project>
Expand All @@ -44,8 +44,8 @@ Usage
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
<version>2.4</version>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.2.0</version>
<configuration>
...
</configuration>
Expand All @@ -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:

+----------+
<project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
<version>2.4</version>
<configuration>
<templateDirectory>org/apache/maven/plugins</templateDirectory>
</configuration>
<dependencies>
...
</dependencies>
<executions>
...
</executions>
</plugin>
</plugins>
</build>
...
</project>
+----------+

or like this:

+----------+
<project>
...
Expand All @@ -107,7 +80,7 @@ Usage
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.x.x</version>
<version>3.2.0</version>
<configuration>
<configLocation>config/maven_checks.xml</configLocation>
<headerLocation>config/maven-header.txt</headerLocation>
Expand All @@ -133,5 +106,5 @@ Usage
practical use.

+----------+
mvn changes:announcement-generate
mvn checkstyle:check
+----------+