anton-johansson/build-markdown-generator

Generates markdown for a build report, containing for example JUnit report, code coverage report, etc.

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