vertx5-parent

Base parent pom for Vert.x 5 projects

The parent pom defines common default configuration for Vert.x 5 projects:

• Base plugins versions
• File encoding
• Java 11 release
• Install test-jar, sources, test-sources and docs artifacts
• Vert.x release/snapshots repositories
• Asciidoc source dir
• Asciidoc target dir
• Generated main sources dir
• Surefire configuration
  • Run tests with module path
  • Netty leak detector

This parent pom provides common default configuration for data object generation and documentation.

Code generation

The Java compiler configures the execution of the Vert.x codegen and docgen processors but does not declare their execution, those processors must be configured explicitly by the pom.

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <executions>
            <execution>
              <id>default-compile</id>
              <configuration>
                <annotationProcessors>
                  <annotationProcessor>io.vertx.codegen.CodeGenProcessor</annotationProcessor>
                </annotationProcessors>
              </configuration>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>

Asciidoc

Asciidoc is generated from src/main/asciidoc in the target/asciidoc/java directory in Asciidoc format at compilation time and can be previewed using the Chrome Asciidoctor.js plugin.

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <executions>
            <execution>
              <id>default-compile</id>
              <configuration>
                <annotationProcessors>
                  <annotationProcessor>io.vertx.docgen.JavaDocGenProcessor</annotationProcessor>
                </annotationProcessors>
              </configuration>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>

Documentation can be generated with mvn asciidoctor:process-asciidoc or mvn asciidoctor:auto-refresh, the Asciidoc files are transformed to HTML the target/docs directory.

This documentation shall be packaged in a -docs.zip file.

  <build>
    <plugin>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
          <executions>
          <execution>
            <id>package-docs</id>
            <goals>
              <goal>single</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugin>
  </build>