Collection of custom rules to be appended to the Maven Enforcer plugin.
Rules (actually the enforce Maven goal) are executed during the validate Maven phase, the same of the Maven Enforcer plugin.
Append this project dependency to the Maven Enforcer plugin, then add any rule at will, like requireReleaseDepsInPlugins. The result looks as following:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>enforce-no-snapshots</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<!-- Add this rule (don't forget the 'implementation' hint! ) -->
<requireReleaseDepsInPlugins implementation="org.apache.maven.enforcer.rule.requireReleaseDepsInPlugins" />
</rules>
<fail>true</fail>
</configuration>
</execution>
</executions>
<dependencies>
<!-- Add this dependency to the plugin -->
<dependency>
<groupId>io.github.thefolle</groupId>
<artifactId>glowing-waffle</artifactId>
<version>1.2.0</version>
</dependency>
</dependencies>
</plugin>In order to only enforce the declared rules, issue the command:
mvn validateMost-common phases like package and test in the default lifecycle include the validate phase. This means that Maven enforces the rules in addition to the usual build steps.
The project currently supports three rules.
Ban SNAPSHOT dependencies of plugins.
In other words, if any plugin in a pom declares a SNAPSHOT dependency, the rule logs it and makes the build to fail.
Plugins in children modules are scanned too.
This rule does not currently accept any parameter.
The rule doesn't do shortcircuitry. In other words, it doesn't stop at the first violation, but it finds all violations and log them before failing.
The rule is not cached.
Enforce that modules' names match a convention (regex).
In other words, if the pom declares a module whose name doesn't match a regex, the rule logs it and makes the build to fail.
This rule accepts the parameter regex, whose value is a regular expression. For instance:
<rules>
<requireModuleNamingConvention implementation="org.apache.maven.enforcer.rule.requireModuleNamingConvention">
<regex>.+-service</regex> <!-- grant any module that has at least one character before terminating with '-service' -->
</requireModuleNamingConvention>
</rules>The rule doesn't do shortcircuitry. In other words, it doesn't stop at the first violation, but it finds all violations and log them before failing.
The rule is not cached.
Require that plugins recognize all the declared parameters in their configuration
In other words, when the pom declares a set of parameters for the configuration of a plugin, the rule checks whether the plugin recognizes all of them.
The rule accepts the level parameter, whose meaning is in relation to the fail parameter proper of the Enforcer plugin:
<configuration>
<rules>
<requireRecognizedConfigurationInPlugins implementation="org.apache.maven.enforcer.rule.requireRecognizedConfigurationInPlugins">
<level>warn</level>
</requireRecognizedConfigurationInPlugins>
</rules>
<fail>true</fail>
</configuration>In the above example, the build does not fail in case of violation because the level parameter overrides the global fail parameter.
Admissible values are warn and error. The default value is error.
The rule currently only checks the first-level children of a <configuration> tag. Namely it doesn't go deep to check sub-parameters.
If you think any rule has bugs or should be configurable or for any other issue/suggestion, please open a GitHub issue for this project.
This project is licensed under the terms of the MIT License.