Microsphere Build

1. Introduction

Microsphere Build is a Java Maven parent POM with common build settings, plugins configuration, etc, which is used for Microsphere Projects, like Microsphere Java, Microsphere Spring, etc.

2. Features

Microsphere Build supports the following features:

• Language Support
• Plugins Management
• Profiles Management
• Project Settings

2.1 Language Support

Microsphere Build supports the Maven project building on Java 8+ TLS and Java 17+ TLS.

2.2 Plugins Management

2.2.1 Default Inherited Plugins

• Maven Compiler Plugin
• Maven Source Plugin
• Flatten Maven Plugin

2.2.2 Profile-Specific Plugins

2.2.2.1 Maven Profile publish Plugins (Recommended, since 0.2.0)

• Maven JavaDoc Plugin
• Maven Release Plugin
• Maven Enforce Plugin
• Maven GPG Plugin
• Git Commit Id Plugin
• Central Publishing Maven Plugin

As of June 30, 2025 OSSRH has reached end of life and has been shut down. All OSSRH namespaces have been migrated to Central Publisher Portal.

See Publishing By Using the Maven Plugin.

2.2.2.2 Maven Profile release Plugins

• Maven JavaDoc Plugin
• Maven Release Plugin
• Maven Enforce Plugin
• Maven GPG Plugin
• Git Commit Id Plugin
• Nexus Maven Plugin

If you want to release the Java artifacts using OSSRH staging API, please see Publishing By Using the Portal OSSRH Staging API.

2.2.2.3 Maven Profile ci Plugins

• Sign Maven Plugin

2.2.2.4 Maven Profile test Plugins

• Maven Failsafe Plugin
• Maven Checkstyle Plugin
• Maven Surefire Plugin

2.2.2.5 Maven Profile coverage Plugins

• Maven JaCoCo Plugin

2.2.2.6 Maven Profile docs Plugins

• Asciidoctor Maven Plugin
• Docbkx Maven Plugin
• Build Helper Maven Plugin

2.3 Profiles Management

• publish (Recommended, since 0.2.0)
• release (Legacy)
• ci
• test
• coverage
• docs
• java8+ (activated by JDK version)
• java9+ (activated by JDK version)
• java11 (activated by JDK version)
• java9-15 (activated by JDK version)
• java16+ (activated by JDK version)

2.4 Project Settings

2.4.1 Defaults Settings

2.4.1.1 Resources Settings

<resources>
    <resource>
        <directory>src/main/java</directory>
        <filtering>true</filtering>
        <includes>
            <include>**/*.properties</include>
            <include>**/*.xml</include>
        </includes>
    </resource>
    <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
        <includes>
            <include>**/*</include>
        </includes>
    </resource>
</resources>

2.4.2 Profiles Settings

2.4.2.1 Maven Profile java8+ Settings

Maven JavaDoc Plugin will be added the options -Xdoclint:none.

2.4.2.2 Maven Profile java9+ Settings

Maven Compiler Plugin's property maven.compiler.release references on the another property ${java.version}.

2.4.2.3 Maven Profile java11 Settings

Maven JavaDoc Plugin will use the configuration source based on the property ${maven.compiler.source}.

2.4.2.4 Maven Profile java9-15 Settings

Maven Surefire Plugin will append the argument line --illegal-access=permit for accessing to internal classes

2.4.2.5 Maven Profile java16+ Settings

Maven Surefire Plugin will append the argument line --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED for accessing to JDK modules' classes.

3. Usage

3.1 Java 8+ Maven Project

The root project's pom.xml should set the parent as follows:

    <parent>
        <groupId>io.github.microsphere-projects</groupId>
        <artifactId>microsphere-build</artifactId>
        <version>0.2.0</version>
    </parent>