Anton Johansson :: Build Markdown Generator :: Maven Plugin

Initiates the generation of markdown through a Maven goal.

License	Apache License, Version 2.0
Categories	Maven Build Tools Ant
GroupId	com.anton-johansson
ArtifactId	build-markdown-generator-maven-plugin
Last Version	1.0.0
Release Date	Jul 12, 2017
Type	maven-plugin
Description	Anton Johansson :: Build Markdown Generator :: Maven Plugin Initiates the generation of markdown through a Maven goal.
Project Organization

Download build-markdown-generator-maven-plugin

Filename	Size
build-markdown-generator-maven-plugin-1.0.0.pom
build-markdown-generator-maven-plugin-1.0.0.jar	7 KB
build-markdown-generator-maven-plugin-1.0.0-sources.jar	4 KB
build-markdown-generator-maven-plugin-1.0.0-javadoc.jar	23 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.anton-johansson</groupId>
    <artifactId>build-markdown-generator-maven-plugin</artifactId>
    <version>1.0.0</version>
</plugin>

Dependencies

compile (1)

Group / Artifact	Type	Version
com.anton-johansson : build-markdown-generator-core	jar	1.0.0

provided (3)

Group / Artifact	Type	Version
org.apache.maven : maven-core	jar	3.3.9
org.apache.maven : maven-plugin-api	jar	3.3.9
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.5

Project Modules

There are no modules declared in this project.

Build Markdown Generator

Generates markdown for build reports, containing for example JUnit report, code coverage report, etc. A success example result can be found here and a failure example result can be found here.

Supported reports

• Checkstyle
• Cobertura
• JUnit

Entry points

Also see the samples.

Maven

$ mvn com.anton-johansson:build-markdown-generator-maven-plugin:1.0.0:generate \
      -DbuildMarkdownGenerator.detailedReportURL=https://my-jenkins-instance/job/build/130/ \
      -DbuildMarkdownGenerator.checkstyleReportPatterns=**/target/checkstyle-result.xml \
      -DbuildMarkdownGenerator.checkstyleDetailedReportURL=https://my-jenkins-instance/job/build/130/checkstyleResult/ \
      -DbuildMarkdownGenerator.junitReportPatterns=**/target/surefire-reports/TEST-*.xml \
      -DbuildMarkdownGenerator.junitDetailedReportURL=https://my-jenkins-instance/job/build/130/testReport/ \
      -DbuildMarkdownGenerator.junitDetailedReportForTestURL=https://my-jenkins-instance/job/build/130/testReport/[packageName]/[simpleClassName]/[testName] \
      -DbuildMarkdownGenerator.coberturaCoverageReport=target/site/cobertura/coverage.xml \
      -DbuildMarkdownGenerator.coberturaLineThreshold=90 \
      -DbuildMarkdownGenerator.coberturaBranchThreshold=80 \
      -DbuildMarkdownGenerator.coberturaDetailedReportURL=https://my-jenkins-instance/job/build/130/cobertura/

Release instructions

$ git checkout ${commitSHA}
$ mvn versions:set -DnewVersion=1.0.0 -DgenerateBackupPoms=false

Update <scm><tag>v1.0.0</tag></scm> (would be nice if we could find a Maven goal for this)

$ git add .
$ git commit -m "Set new version"
$ git tag v1.0.0
$ git push --tags
$ mvn deploy -Psonatype-oss-release -Pprivate

License

Apache License © Anton Johansson

Viskan System AB

Versions

Version
1.0.0 Jul 12, 2017