| 1 |
<!-- |
| 2 |
Licensed to the Apache Software Foundation (ASF) under one |
| 3 |
or more contributor license agreements. See the NOTICE file |
| 4 |
distributed with this work for additional information |
| 5 |
regarding copyright ownership. The ASF licenses this file |
| 6 |
to you under the Apache License, Version 2.0 (the |
| 7 |
"License"); you may not use this file except in compliance |
| 8 |
with the License. You may obtain a copy of the License at |
| 9 |
|
| 10 |
http://www.apache.org/licenses/LICENSE-2.0 |
| 11 |
|
| 12 |
Unless required by applicable law or agreed to in writing, |
| 13 |
software distributed under the License is distributed on an |
| 14 |
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 |
KIND, either express or implied. See the License for the |
| 16 |
specific language governing permissions and limitations |
| 17 |
under the License. |
| 18 |
--> |
| 19 |
|
| 20 |
Usage |
| 21 |
===== |
| 22 |
|
| 23 |
To use the maven-enforcer-extension, you must register the extension and configuration. |
| 24 |
|
| 25 |
Maven Extension |
| 26 |
--------------- |
| 27 |
|
| 28 |
You have 2 ways to use Maven extensions within your builds: |
| 29 |
|
| 30 |
* add `maven-enforcer-extension-${project.version}.jar` in `${maven.home}/lib/ext` (no extra dependencies required), |
| 31 |
|
| 32 |
* (since Maven 3.3.1) configure your extension in [.mvn/extensions.xml](https://maven.apache.org/ref/current/maven-embedder/core-extensions.html). |
| 33 |
|
| 34 |
There is actually a third way: add the extension to the `pom.xml`, but in that case it makes more sense to use the [maven-enforcer-plugin](../maven-enforcer-plugin/) instead. |
| 35 |
|
| 36 |
Enforcer Extension |
| 37 |
------------------ |
| 38 |
|
| 39 |
The `.mvn/enforcer-extension.xml` in the root of your Maven project is where you define your rules. |
| 40 |
It's content is similar to an execution-block of the maven-enforcer-plugin |
| 41 |
|
| 42 |
```xml |
| 43 |
<extension> |
| 44 |
<executions> |
| 45 |
<execution> |
| 46 |
<id/> <!-- default: default-extension --> |
| 47 |
<phase/> <!-- default: validate --> |
| 48 |
<configuration> <!-- see Plugin Configuration --> |
| 49 |
<rules/> |
| 50 |
</configuration> |
| 51 |
</execution> |
| 52 |
</executions> |
| 53 |
</extension> |
| 54 |
``` |