Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"outputFile" is missing or invalid #103

Open
rrileyca opened this issue Apr 30, 2024 · 0 comments
Open

"outputFile" is missing or invalid #103

rrileyca opened this issue Apr 30, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@rrileyca
Copy link

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

@rrileyca rrileyca added the bug Something isn't working label Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants