Spring Configuration Transformer Maven Plugin

Spring Config Transformer Maven Plugin

A maven plugin to automatically transform Spring configuration files to html or markdown output.

How to use?

Prerequisite

Please ensure your Spring (SpringBoot ) application is able to generate configuration metadata json file. See Spring Configuration Metadata page for more information.

Plugin Configuration

Spring Config Transformer Maven Plugin

Add the following plugin to your project’s pom.xml file. The plugin will be executed after code has been compiled and metadata file has been generated.

<plugins>
    <plugin>
        <groupId>com.sagguuk</groupId>
        <artifactId>spring-configuration-transformer-maven-plugin</artifactId>
        <!-- Update below to latest available version. For example: 0.0.1-SNAPSHOT-->
        <version>check-the-repo-for-latest-version</version>
        
        <executions>
            <execution>
                <goals>
                    <goal>spring-configuration-transformer</goal>
                </goals>
            </execution>
        </executions>
        
        <configuration>
            <metadataJsonFileName>${project.build.directory}/classes/META-INF/spring-configuration-metadata.json</metadataJsonFileName>
            <outputFileName>docs/my-app-properties.html</outputFileName>
            <reportTitle>Title of your report</reportTitle>
        </configuration>
    
    </plugin>
</plugins>

Configuration

• metadataJsonFileName The plugin comes with default template to generate html outputs. But you can customise and provide the location of your template file in this variable.
• outputFileName Name of the output file name. You can either provide absolute path or file will be created in the root folder. Feel free to use maven variables to build the path.
• reportTile Title for the generated report

Source Code

GitHub - jssaggu/spring-configuration-transformer: Spring Properties Processor Maven Plugin