schema-parent-pom's Introduction

schema-parent-pom

This a parent pom for schema projects.

This parent pom implements the following:

Compose data models using maven dependency framework. Use the maven to re-use, version, release and publish avro data models. (test-schema -> test-schema-common)
Validate avro schemas (extensible). (documentation, naming, compatibility with previously released versions...)
Add a unique ID to the schemas (mvnId = "group:artifact:version:id")
Easy to use, flexible resolvers to resolve schema IDs (pick the one that fits your dependencies best): jaxrs based or aether based
Generate and publish java classes along with javadoc. (publishing for other languages can se set up) (@Imutable support, @Nullable/@Nonnull) see
Generate package and publish the avro schemas, see.
Generate and publish avrodoc, see for maven repo publish or for gh-pages doc publish.

Here is how a schema project that uses this parent will look like:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.spf4j.avro.examples</groupId>
  <artifactId>test-schema</artifactId>
  <packaging>jar</packaging>
  <version>MY_VERSION</version>
  <name>${project.artifactId}-${project.version}</name>
  <description>Avro schema example</description>
  <parent>
    <groupId>org.spf4j.avro</groupId>
    <artifactId>schema-parent-pom</artifactId>
    <version>LATEST</version>
  </parent>
  <dependencies>
    <dependency> <!-- this schema will re-use schema's from this dependency -->
        <groupId>org.spf4j.avro.examples</groupId>
        <artifactId>test-schema-common</artifactId>
        <version>1.5</version>
    </dependency>
  </dependencies>
</project>

for an example please see core-schema

Recommend Projects