diff --git a/doc/overview.html b/doc/overview.html index 6bcbde8..41e331a 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -465,6 +465,60 @@

KeyValuesSystem

This is the entry point into Ezkv and is used to load the initial part of the chain of resources. The bootstrapping part of your application will call it first and will often convert or pass the loaded key values to another system.

+

Extensions and Integration

+ +Most of the modules are explained below in the modules table. + +

Maven Plugin

+ +EZKV has a maven plugin that will load config as properties in a Maven build. + +This plugin is similar to properties-maven-plugin except +that it will use EZKV to load the properties. Unlike the Codehaus properties plugin +this plugin allows chain loading of config. +

+However like the Codehaus properties plugin this plugin has the following limitations: +

+

+This plugin (as all other) is executed in the later phase - when project model is +already build in memory. +

+

+So properties read from external files by this plugin can not by used in project +definitions in items like {@code }, {@code } and so on. +

+

+Properties read by plugin in one module are not propagated to other modules or child +projects. +

+

+Properties are only available for other plugins in runtime like for +maven-resource-plugin for filtering resources. +

+ +Example: + +{@snippet lang = xml : + + io.jstach.ezkv + ezkv-maven-plugin + + + initialize + + read-config + + + + + file:///${project.basedir}/src/main/resources/db/database.properties + + + + + +} diff --git a/ezkv-maven-plugin/pom.xml b/ezkv-maven-plugin/pom.xml index fcd1fcc..b844476 100644 --- a/ezkv-maven-plugin/pom.xml +++ b/ezkv-maven-plugin/pom.xml @@ -1,4 +1,5 @@ - 4.0.0 @@ -34,4 +35,27 @@ 3.15.1 + + + + org.apache.maven.plugins + maven-jar-plugin + + + + io.jstach.ezkv.maven + + + + + + + + + doc + + true + + + \ No newline at end of file