Skip to content

Commit db2764f

Browse files
authored
docs: add description
1 parent 8f924d3 commit db2764f

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## requireDependencyRepository
2+
3+
This project presents custom rule requireDependencyRepository for [maven-enforcer-plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/index.html).
4+
5+
#### Purpose
6+
requireDependencyRepository is meant to ensure that specified artifact is received from specified repository.
7+
8+
#### Minimum requirements
9+
- Java 8
10+
- Maven 3.6.3
11+
- Maven Enforcer Plugin 3.2.1
12+
13+
#### Usage
14+
15+
Example of usage.
16+
17+
Add such declaration to your pom.xml:
18+
19+
```xml
20+
<build>
21+
<plugins>
22+
...
23+
<plugin>
24+
<artifactId>maven-enforcer-plugin</artifactId>
25+
<executions>
26+
<execution>
27+
<id>enforce-dependency-repository</id>
28+
<goals>
29+
<goal>enforce</goal>
30+
</goals>
31+
<configuration>
32+
<rules>
33+
<requireDependencyRepository>
34+
<repositoryId>YOUR REPOSITORY ID</repositoryId>
35+
<groupId>YOUR GROUP ID</groupId>
36+
<artifactId>YOUR ARTIFACT ID</artifactId>
37+
</requireDependencyRepository>
38+
</rules>
39+
</configuration>
40+
</execution>
41+
</executions>
42+
<dependencies>
43+
<dependency>
44+
<groupId>eu.eureka-bpo.maven</groupId>
45+
<artifactId>require-dependency-repository</artifactId>
46+
<version>SNAPSHOT</version>
47+
</dependency>
48+
</dependencies>
49+
</plugin>
50+
...
51+
</plugins>
52+
</build>
53+
```

0 commit comments

Comments
 (0)