Usage

Plugin goals in the Maven build lifecycle

The C4-PlantUML Maven Plugin goals are bound to default phases in the build lifecycle, so you only have to specify the goals you want to use:

Plugin goals in Maven lifecycle

From the command line:

To check the syntax of your files, you’ll do:

mvn compile org.thewonderlemming.c4plantuml:c4plantuml-maven-plugin:check-syntax

To lint your files, you’ll do:

mvn compile org.thewonderlemming.c4plantuml:c4plantuml-maven-plugin:lint

You can the list of the available goals there.

Configuring your plugin

You should specify the version in your project’s plugin configuration:

<project>
    ...
    <build>
        <!-- Fixing the plugin version -->
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.thewonderlemming.c4plantuml</groupId>
                    <artifactId>c4plantuml-maven-plugin</artifactId>
                    <version>1.0.0-RC1</version>
                </plugin>
            </plugins>
        </pluginManagement>
        
        <!-- Configuring the goals -->
        <plugins>
            <plugin>
                <groupId>org.thewonderlemming.c4plantuml</groupId>
                <artifactId>c4plantuml-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <id>aggregating-c4-information-into-graphml-report</id>
                        <goals>
                            <goal>check-syntax</goal>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugin>
    </build>
    ...
</project>