This Maven-Plugin helps you not to forget to change references to your artifacts. For example if you reference your binary in the README.md file, this plugin will break the build, if you forgot to update the version number there.
The plugin automatically extracts the naming schema of your artifact from the assembly plugin in the pom.xml
file.
In addition it can automatically adapt the references so that they refer to the current version.
Add the following lines to your pom.xml
file.
<plugin>
<groupId>com.exasol</groupId>
<artifactId>artifact-reference-checker-maven-plugin</artifactId>
<version>0.3.1</version>
<executions>
<execution>
<goals>
<goal>verify</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- Add configuration here -->
</configuration>
</plugin>
- When you run
mvn verify
this plugin will run the checks - Run checks manually:
mvn artifact-reference-checker:verify
- Unify the versions using:
mvn artifact-reference-checker:unify
-
Exclude file: You can exclude files from verification and unification.
<excludes> <exclude>doc/changes/*</exclude> </excludes>
If the path starts with a
/
it is relative to the project's root directory. Otherwise, it acts as a pattern that can also exclude files in nested directories without specifying the whole path. For example*.md
.