documentation home

Migrate from v1.5 to v1.5.1

Up to version 1.5.1, the output configuration under Gradle was similar to that under Maven and looked like this:

miredot {
    output {
        // optional common configuration
        html {
            // optional html configuration
        }
        docx {
            // optional docx configuration
        }
    }
}

While this configuration worked well under Maven, there are a number of issues with this structure under Gradle, since Gradle does not allow us to distinguish between tags that are present in the configuration (such as the html and docx tags above) and tags that are simply not present. This lead to many subtle errors and inconveniences such as unwarranted warnings and unneeded checks.

To resolve these issues, the configuration of the output has changed somewhat since Miredot 1.5.1:

miredot {
    output {
        location = '/out/'
        formats {
            'docx' {
                // optional docx configuration options
            }
            'html' {
                // optional html configuration options
            }
        }
    }
}

The formats section is required. Note that docx export is only supported in the professional version. If no output formats are specified, no output is written to disk, but Miredot will still execute all analysis and checks.