https://github.com/eclipse-vertx/vertx5-parent

Vert.x 5 Parent pom
https://github.com/eclipse-vertx/vertx5-parent

java maven vertx

Last synced: about 1 month ago
JSON representation

Vert.x 5 Parent pom

• Host: GitHub
• URL: https://github.com/eclipse-vertx/vertx5-parent
• Owner: eclipse-vertx
• License: apache-2.0
• Created: 2024-06-16T08:48:10.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-09T21:13:21.000Z (about 2 months ago)
• Last Synced: 2024-09-27T07:24:00.747Z (about 1 month ago)
• Topics: java, maven, vertx
• Homepage:
• Size: 29.3 KB
• Stars: 1
• Watchers: 12
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## 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.

```xml

  

    

      

        

          maven-compiler-plugin

          

            

              default-compile

              

                

                  io.vertx.codegen.CodeGenProcessor

                

              

            

          

        

      

    

  

```

### 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.

```xml

  

    

      

        

          maven-compiler-plugin

          

            

              default-compile

              

                

                  io.vertx.docgen.JavaDocGenProcessor

                

              

            

          

        

      

    

  

```

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.

```xml

  

    

      

        maven-assembly-plugin

          

          

            package-docs

            

              single

            

          

        

      

    

  

```