Skip to content

Commit 80a98b9

Browse files
author
Ben Romberg
committed
improve readme
1 parent f2d421e commit 80a98b9

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
[![Build Status](https://buildhive.cloudbees.com/job/andrena/job/no-package-cycles-enforcer-rule/badge/icon)](https://buildhive.cloudbees.com/job/andrena/job/no-package-cycles-enforcer-rule/)
22

3-
Usage: Build and add the following plugin:
3+
This Maven Enforcer Rule checks your project for package cycles. It fails the build if any package cycle is found, showing you the packages and classes involved in the cycle.
4+
5+
Usage: Add the following plugin to your POM:
46

57
```
68
<plugin>
@@ -19,7 +21,7 @@ Usage: Build and add the following plugin:
1921
<goals>
2022
<goal>enforce</goal>
2123
</goals>
22-
<phase>verify</phase>
24+
<phase>compile</phase>
2325
<configuration>
2426
<rules>
2527
<NoPackageCyclesRule implementation="de.andrena.tools.nopackagecycles.NoPackageCyclesRule" />
@@ -30,6 +32,7 @@ Usage: Build and add the following plugin:
3032
</plugin>
3133
```
3234

33-
See also: original version at http://stackoverflow.com/questions/3416547/maven-jdepend-fail-build-with-cycles
34-
35-
Improved by showing all packages afflicted with cycles and the corresponding classes importing the conflicting packages.
35+
See also:
36+
* The original version by Daniel Seidewitz on [Stackoverflow](http://stackoverflow.com/questions/3416547/maven-jdepend-fail-build-with-cycles). Improved by showing all packages afflicted with cycles and the corresponding classes importing the conflicting packages.
37+
* [JDepend](https://github.com/clarkware/jdepend), the library being used to detect package cycles.
38+
* For more information about package cycles, see ["The Acyclic Dependencies Principle" by Robert C. Martin (Page 6)](http://www.objectmentor.com/resources/articles/granularity.pdf).

0 commit comments

Comments
 (0)