search

aistomin / maven-dependencies-analyser

Maven plugin that analyses and validates that all the project dependencies are up-to-date.
Other
4 stars 1 forks source link
maven maven-dependency-reporting maven-dependency-updates maven-plugin maven-pom maven-repository

readme

Maven Dependencies Analyser

CI Hits-of-Code codecov Maven Central javadoc

Maven plugin that analyses and validates that all the project dependencies are up-to-date.

Getting Started

System Requirements

Validate Project Dependencies

Add the following configuration to your project's pom.xml:

<build>
    <plugins>
        <!-- other plugins are there -->
        <plugin>
            <groupId>com.github.aistomin</groupId>
            <artifactId>maven-dependencies-analyser</artifactId>
            <version>3.0</version>
            <configuration>
                <level>ERROR</level>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <!-- other plugins are there -->
    </plugins>
</build>

With this configuration the Maven build will fail in case any of the dependencies of your project is out-of-date. If you do not want the build to fail, but rather just to show the warning, please change the level configuration value from ERROR to WARNING.

Using the enabled configuration you may easily turn the complete dependencies validation off. Then the configuration section will look like:

<configuration>
    <level>ERROR</level>
    <enabled>false</enabled>
</configuration>

For the further information, please check out our example project.

Please keep in mind that currently we validate only dependencies that are published in the Maven Central Repository.

Licence

The project is licensed under the terms of the Apache License, Version 2.0.

Have You Found a Bug? Do You Have Any Suggestions?

Although we try our best, we're not robots and bugs are possible :) Also we're always happy to hear some suggestions, ideas and thoughts from you. Don't hesitate to create an issue. It will help us to make our project better. Thank you in advance!!!

How to Contribute?

Do you want to help us with the project? We will be more than just happy. Please: fork the repository, make changes, submit a pull request. We promise to review your changes in the next couple of days and merge them to the master branch, if they look correct. To avoid frustration, before sending us your pull request please run the following command and make sure there are no errors:

$ mvn clean install package javadoc:javadoc

Keep in mind our system requirements.