Skip to content

Documentation: Excludes should be placed in pluginManagement (#637) #638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025
Merged

Documentation: Excludes should be placed in pluginManagement (#637) #638

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions src/site/apt/examples/violation-exclusions.apt.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,28 +89,32 @@ org.apache.maven.ClassB=UnusedPrivateField,UnusedFormalParameter,UnusedPrivateMe
If you want more flexibility and exclude classes with a certain name, or whole packages,
for example because of generated code, you have to do this in the <<<<configuration\>>>> section of the plugin,
using the <<<<excludes\>>>> or <<<<excludeRoots\>>>> elements.
To avoid confusion, don't write those to the plugin's configuration as a <<<<build\>>>> and <<<<reporting\>>>> plugin.
Instead, configure the plugin in the <<<<pluginManagement\>>>> section of your POM, so executions of the build and site lifecycle pick it up.

+-----+
<project>
...
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
<version>${project.version}</version>
<configuration>
<excludes>
<exclude>**/*Bean.java</exclude>
<exclude>**/generated/*.java</exclude>
</excludes>
<excludeRoots>
<excludeRoot>target/generated-sources/stubs</excludeRoot>
</excludeRoots>
</configuration>
</plugin>
</plugins>
</reporting>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
<version>${project.version}</version>
<configuration>
<excludes>
<exclude>**/*Bean.java</exclude>
<exclude>**/generated/*.java</exclude>
</excludes>
<excludeRoots>
<excludeRoot>target/generated-sources/stubs</excludeRoot>
</excludeRoots>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
...
</project>
+-----+