Package org.kordamp.maven.checker

Class MavenCentralChecker

java.lang.Object

org.kordamp.maven.checker.MavenCentralChecker

public class MavenCentralChecker
extends java.lang.Object

Checks if a POM complies with the rules for uploading to Maven Central. The following blocks are required:

• <groupId>
• <artifactId>
• <version>
• <name>
• <description>
• <url>
• <licenses>
• <scm>

All previous blocks may be supplied by a parent POM with the exception of <artifactId>. The following blocks are forbidden if strict = true

• <repositories>
• <pluginRepositories>

Since:

1.0.0

See Also:

http://maven.apache.org/repository/guide-central-repository-upload.html, https://central.sonatype.org/pages/requirements.html

Constructor Summary

Constructors

Constructor	Description
MavenCentralChecker()

Method Summary

Modifier and Type	Method	Description
static void	check(Logger log, org.apache.maven.project.MavenProject project, boolean release, boolean strict)	Checks the resolved model of the given MaveProject for compliance.
private static org.apache.maven.project.MavenProject	readProject(java.io.File pom)
private static java.lang.String	resolveParentName(java.io.File directory, org.apache.maven.model.Model fullModel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MavenCentralChecker

public MavenCentralChecker()

Method Detail

check

public static void check(Logger log,
                         org.apache.maven.project.MavenProject project,
                         boolean release,
                         boolean strict)
                  throws PomCheckException

Checks the resolved model of the given MaveProject for compliance.

Parameters:

log - the logger to use.

project - the project to be checked.

release - if true checks if version is not -SNAPSHOT.

strict - if true checks that <repositories> and <pluginRepositories> are not present

Throws:

PomCheckException - if the POM is invalid

resolveParentName

private static java.lang.String resolveParentName(java.io.File directory,
                                                  org.apache.maven.model.Model fullModel)

readProject

private static org.apache.maven.project.MavenProject readProject(java.io.File pom)