README.md

A maven plugin to generate UML diagrams using PlantUML syntax.

This project is a fork of https://github.com/jeluard/maven-plantuml-plugin. Many thanks to Julien Eluard, the founder of the original project. Big thanks also to all the other contributors in the source control system tree.

Important note

If you want to use versions of PlantUML greater than 8059 you have to use version 1.5.0 and following of this plugin.

Usage

To generate images from PlantUML description add following dependency to your pom.xml:

<build>
  <plugins>
    <plugin>
      <groupId>com.github.funthomas424242</groupId>
      <artifactId>plantuml-maven-plugin</artifactId>
      <version>1.5.2</version>
      <configuration>
        <truncatePattern>src/main/*</truncatePattern>
        <sourceFiles>
          <directory>${basedir}</directory>
          <includes>
            <include>src/main/plantuml/**/*.txt</include>
          </includes>
        </sourceFiles>
      </configuration>
      <dependencies>
        <dependency>
          <groupId>net.sourceforge.plantuml</groupId>
          <artifactId>plantuml</artifactId>
          <version>1.2020.19</version>
          <scope>runtime</scope>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>

Note that you must explicitely define the PlantUML version you want to use.

Then execute command:

mvn clean com.github.funthomas424242:plantuml-maven-plugin:generate

Extra configuration options

outputDirectory Directory where generated images are generated. Defaults to ${basedir}/target/plantuml

outputInSourceDirectory Whether or not to generate images in same directory as the source file. Defaults to false.

format Output format. Defaults to png.

verbose Wether or not to output details during generation. Defaults to false.

Released under Apache 2 license.