Repository navigation
Support Markdown as a standalone report output format - #278
Draft
slachiewicz wants to merge 2 commits into
Draft
slachiewicz wants to merge 2 commits into
slachiewicz wants to merge 2 commits into
Conversation
Adds doxia-module-markdown at runtime so -Doutput.format=markdown finds a SinkFactory. It brings flexmark (27 jars, about 2 MB) into every report plugin built on this library; the output file keeps the <outputPath>.<format> naming, so it ends in .markdown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A report run as a standalone goal can write Doxia markup instead of a skinned HTML page with
-Doutput.format=<format>, but only formats whose Doxia module is on the plugin's classpath work, which werexdoc,aptandxhtml. This addsdoxia-module-markdownat runtime, so-Doutput.format=markdownwrites the report as Markdown, for example to publish it in a repository wiki or a pull request comment.The output file keeps the existing naming,
<outputPath>.<format>, so it ends in.markdown. The module brings flexmark along: 27 jars, about 2 MB, in every report plugin that depends on this library. They are only used for standalone runs; duringmvn sitethe site plugin supplies Doxia. A lighter alternative is to leave the module out and document addingdoxia-module-markdownas a plugin dependency, which works without this change. The site index now lists the four formats.Verified:
mvn -P run-its verify→ 6 ITs pass; without the new dependency the extendeduse-as-direct-mojo-markupIT fails with "Cannot find SinkFactory for Doxia output format: markdown".