maven 2 plugin

[Mike Nereson]

Mykola, If you are ready to publicize the maven plugin, we should document the plugin's usage, conventions, etc.

Can you write up the details here and I'll format it and put it into the site?

I would think we would want to document how to get it, a description, the goals, all of the configuration options and their default values. At the least.

~ Mike Nereson

[Mykola Nikishov]

Hi!

"Mike Nereson" <miken...@gmail.com> writes:

> Can you write up the details here and I'll format it and put it into the site?

Yes, in a one or two days.

--
MAN-UANIC

[Mykola Nikishov]

"Mike Nereson" <miken...@gmail.com> writes:

1. How to install

Add our repository hosted in the google code's svn:

<project>
<pluginRepositories>
<pluginRepository>
<id>whatever.you.like</id>
<url>http://architecturerules.googlecode.com/svn/maven2/</url>
<!-- enable snapshots from this repo -->
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</project>

1.1 For a single project

<project>
<build>
<plugins>
<plugin>
<groupId>info.manandbytes</groupId>
<artifactId>maven-architecture-rules-plugin</artifactId>
<version>0.0-SNAPSHOT</version>
<configuration />
<executions>
<execution>
<phase>test</phase>
<goals>
<goal>assert</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

1.2 For a multi-module project

<project>
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>info.manandbytes</groupId>
<artifactId>maven-architecture-rules-plugin</artifactId>
<version>0.0-SNAPSHOT</version>
<configuration />
<executions>
<execution>
<phase>test</phase>
<goals>
<goal>assert</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>info.manandbytes</groupId>
<artifactId>maven-architecture-rules-plugin</artifactId>
<version>0.0-SNAPSHOT</version>
</plugin>
</plugins>
</build>
</project>

2. Use our rules

With this really minimal configuration a single assertion to check would
be that there are no packages involved in a cyclic dependency (see issue
http://code.google.com/p/architecturerules/issues/detail?id=44).

You may run 'mvn test' (or any other goal which includes 'test' phase,
i.e. 'package' or 'verify' but obviously not 'compile') right now. All
other steps are optional ;-)

3. Use *your* rules

See http://72miles.com/architecturerules/sample-configuration for
how to create your own architecture-rules.xml.

--
MAN-UANIC