rodnansol / spring-configuration-property-documenter

Tool to document Spring Configuration Properties - Leave us a feedback: https://github.com/rodnansol/spring-configuration-property-documenter/discussions/74
Apache License 2.0
37 stars 5 forks source link

"outputFile" is missing or invalid #103

Open rrileyca opened 5 months ago

rrileyca commented 5 months ago

Describe the bug When I run mvn spring-configuration-property-documenter:generate-and-aggregate-documents -pl my-module, I get this error:

Failed to execute goal org.rodnansol:spring-configuration-property-documenter-maven-plugin:0.7.1:generate-and-aggregate-documents (default-cli) on project my-module: The parameters 'outputFile' for goal org.rodnansol:spring-configuration-property-documenter-maven-plugin:0.7.1:generate-and-aggregate-documents are missing or invalid -> [Help 1]

To Reproduce Essentially following the multi-module guide, I add this config to a module that has dependencies on all the other classes:

<build>
    <plugins>
        <plugin>
            <groupId>org.rodnansol</groupId>
            <artifactId>spring-configuration-property-documenter-maven-plugin</artifactId>
            <version>0.7.1</version>
            <executions>
                <execution>
                    <id>aggregate-docs-markdown</id>
                    <goals>
                        <goal>generate-and-aggregate-documents</goal>
                    </goals>
                    <phase>package</phase>
                    <configuration>
                        <type>MARKDOWN</type>
                        <inputs>
                            <input>
                                <name>My Module</name>
                                <description>Description for My Module</description>
                                <input>../my/module/target/classes/META-INF/spring-configuration-metadata.json</input>
                            </input>
                        </inputs>
                        <outputFile>target/docs.md</outputFile>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Expected behavior Expecting it to work and not error out

Screenshots

Additional context Note that if I run the same maven command with -DoutputFile, the command doesn't error out, but the template is blank like this:

# my-module
## Table of Contents

This is a generated file, generated at: **2024-04-30T16:30:11.203122567**

I verified the POM contents are correct with mvn help:effective-pom -pl my-module