Repository files navigation

The Vert.x stack : Vert.x + the endorsed modules

This project provides pre-configured Maven poms for using in your projects, allowing you to consume the Vert.x stackeasily.

This artifactio.vertx:stack-depchain is a POM projects can import to get the dependencies it needs for runningthe base stack:

<dependency>  <groupId>io.vertx</groupId>  <artifactId>vertx-stack-depchain</artifactId>  <version>3.5.1</version>  <type>pom</type></dependency>

ABOM is a also a POM youcan import in your project. It will not add dependencies to your POM, instead it will set the correct versions to use.Therefore it should be used with explicit dependencies:

<dependencyManagement>  <dependencies>    <dependency>      <groupId>io.vertx</groupId>      <artifactId>vertx-stack-depchain</artifactId>      <version>3.5.1</version>      <type>pom</type>      <scope>import</scope>    </dependency>  </dependencies></dependencyManagement>  <dependencies>    <dependency>      <groupId>io.vertx</groupId>      <artifactId>vertx-core</artifactId>    </dependency>    ...  </dependencies>

1. Add it tovertx-dependencies (open the project, add it to thepom.xml, install, commit and push)
2. Add it tostack-depchain/pom.xml (open the project, add the dependency, without the version (inherited fromvertx-dependencies))
3. Add it in the stack manager:

• Open./stack-manager/src/main/descriptor/vertx-stack-full.json
• Add the dependency. If the dependency must be embedded in thefull distribution, setincluded totrue. Don't forget to use the\${version}.

4. Add it to the doc distribution:

• Open./stack-docs/pom.xml
• Add thedocs dependency (the using<classifier>docs</classifier> and<type>zip</type>)
• Add thesource dependency (the<classifier>sources</classifier>)
• Add thecopy instruction for the ant execution:

<copy todir="${project.build.directory}/docs/vertx-hawkular-metrics/">    <fileset dir="${project.build.directory}/work/vertx-hawkular-metrics-docs-zip"/></copy>

• Save thepom.xml file
• Build (mvn clean install from the root).

5. Make it polyglot (unless the module is not polyglot, e.g. a cluster manager)

• Kotlin: invertx-lang-kotlin, editvertx-lang-kotlin/pom.xml
  • Add anoptional dependency to the POM
  • Update the list in themaven-dependency-plugin config
• RxJava3: invertx-rx, editrx-java3/pom.xml
  • Add anoptional dependency to the POM
  • Update the list in themaven-dependency-plugin config
• RxJava2: invertx-rx, editrx-java2/pom.xml
  • Add anoptional dependency to the POM
  • Update the list in themaven-dependency-plugin config

6. Add it to the website invertx-web-site:

• Edit the docs summary pagedocs/metadata/<version>.jsx, useTech Preview label

7. Add it to the starter website invertx-starter:

• Edit the stack definition filesrc/main/resources/starter.json
  • Add the module details in one of the categories (web, data, ...etc)
  • Exclude the module from versions that did not have it (exclusions)