dtrott / maven-protoc-plugin

Maven Protocol Buffers (protoc) Plugin that calls the protocol buffers compiler.
http://maven.davidtrott.com/repository/com/google/protobuf/tools/maven-protoc-plugin/0.1.2/
43 stars 129 forks source link

Maven Protocol Buffers (protoc) Plugin


A minimal configuration to invoke this plugin would be:

<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">

4.0.0
<groupId>com.mycompany.example</groupId>
<artifactId>example-protoc</artifactId>
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>protoc-example</name>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.5</source>
                <target>1.5</target>
            </configuration>
        </plugin>
        <plugin>
            <groupId>com.google.protobuf.tools</groupId>
            <artifactId>maven-protoc-plugin</artifactId>
            <configuration>
                <protocExecutable>/usr/local/bin/protoc</protocExecutable>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>compile</goal>
                        <goal>testCompile</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<dependencies>
    <dependency>
        <groupId>com.google.protobuf</groupId>
        <artifactId>protobuf-java</artifactId>
        <version>2.3.0</version>
    </dependency>
</dependencies>

You must:

Once this is all done add your *.proto files to the directory: src/main/proto

Everything should then build with a: mvn clean install

You may also need to add the following to your settings.xml to download the plugin:

        <pluginRepositories>
            <pluginRepository>
                <id>dtrott</id>
                <url>http://maven.davidtrott.com/repository</url>
            </pluginRepository>
        </pluginRepositories>  

Normally this plug-in executes the protoc compilation on every execution this can be overriden by setting:

true

If you build on NFS you may also need the following setting:

10000