This repository has been archived by the owner. It is now read-only.
Clone or download

README.adoc

Maven Plugin for Eclipse Vert.x

The project has been migrated to: https://github.com/reactiverse/vertx-maven-plugin and https://reactiverse.io/vertx-maven-plugin/ for the documentation

This repository should not be used anymore.

This Maven plugin is a one-stop-shop for packaging, running, starting and stopping vert.x Java applications. This plugin combines the goals of Maven Shade, Maven Exec into one, allowing the users to have a simplified pom.xml.

Features

The following are the list of features that will be part of the plugin:

  • Packaging the vert.x application as fat or uber jar

  • Running vert.x application as part of maven build in forked or unforked mode

  • Starting vert.x application a daemon mode by tagging with a autogenerated id or configurable id i.e. -id option to vertx start

  • Setup Set up your existing or new maven project with vert.x maven plugin and vert.x core dependencies

  • Stopping vert.x application running daemon mode, this also allows to pass multiple application id’s to be stopped

  • ✓ Ability to pass vertx configuration -conf automatically if a file named artifactId.json or artifactId.yaml or or artifactId.yml is present in project sources under src/main/conf. The users can also configure the same via plugin configuration. Refer to vertx:run for more information

  • ✓ Ability to perform when redeploy is enabled, please check the vertx:run for more information

  • ✓ Ability to perform SPI combining when serviceProviderCombination is configured vertx:package for more information

Plugin Goals

Goal

Description

vertx-maven-plugin:package

Package vert.x application into a fat jar

vertx-maven-plugin:run

Runs the vert.x application from the maven build

vertx-maven-plugin:start

Will start the vert.x application as daemon

vertx-maven-plugin:setup

Set up your existing or new maven project with vert.x maven plugin and vert.x core dependencies

vertx-maven-plugin:stop

Will stop the vert.x application running as daemon

Documentation

Issues

If you feel to add any feature you can open issue in https://github.com/reactiverse/vertx-maven-plugin/issues and we will try to address it as soon as possible

Contributing

We love contributions, if you wish to contribute a patch or feature, please open a issue in https://github.com/reactiverse/vertx-maven-plugin/issues and send in a PR.