Knot.x Extension Maven Archetype

Use this archetype to generate a custom Knot.x extension:

• Knot / Gateway API
• Adapter

Details regarding the content of a project generated using this archetype can be found in the README.md file in src/main/resources/archetype-resources in a particular submodule (or in the main directory once a project has been generated).

Building the archetype

To build the archetype and install it in your local Maven repository, simply run

    mvn clean install

Using the Archetype to Generate a Project

You can generate a new project using the following command:

• Knot

  mvn archetype:generate -DarchetypeGroupId=io.knotx -DarchetypeArtifactId=knotx-knot-archetype -DarchetypeVersion=X.Y.Z

• Adapter

  mvn archetype:generate -DarchetypeGroupId=io.knotx -DarchetypeArtifactId=knotx-adapter-archetype -DarchetypeVersion=X.Y.Z

Where X.Y.Z is the version of archetype (it corresponds to the Knot.x version) you want to use. For example, if you want to use the archetype 1.3.0 that you've just built use -DarchetypeVersion=1.3.0.

You will be asked to provide values for the following properties:

• groupId - this is the group ID of the Maven project being generated
• artifactId - this is the Artifact ID of the project being generated
• version - this is the initial version of the project being generated
• package - this is the base package for all Java classes in the Maven project being generated
• projectName - this is a human-readable project name to be used in the resulting pom.xml and documentation