JarCasting
JarCasting JarCasting

Anton Johansson :: Build Markdown Generator :: Core

Processes build reports and generates a markdown snippet.

License

License
Categories

Categories

Ant Build Tools
GroupId

GroupId

com.anton-johansson
ArtifactId

ArtifactId

build-markdown-generator-core
Last Version

Last Version

1.0.0
Release Date

Release Date
Type

Type

jar
Description

Description

Anton Johansson :: Build Markdown Generator :: Core
Processes build reports and generates a markdown snippet.
Project Organization

Project Organization

Download build-markdown-generator-core

Filename Size
build-markdown-generator-core-1.0.0.pom
build-markdown-generator-core-1.0.0.jar 36 KB
build-markdown-generator-core-1.0.0-sources.jar 23 KB
build-markdown-generator-core-1.0.0-javadoc.jar 155 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.anton-johansson/build-markdown-generator-core/ -->
<dependency>
    <groupId>com.anton-johansson</groupId>
    <artifactId>build-markdown-generator-core</artifactId>
    <version>1.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.anton-johansson/build-markdown-generator-core/
implementation 'com.anton-johansson:build-markdown-generator-core:1.0.0'
// https://jarcasting.com/artifacts/com.anton-johansson/build-markdown-generator-core/
implementation ("com.anton-johansson:build-markdown-generator-core:1.0.0")
'com.anton-johansson:build-markdown-generator-core:jar:1.0.0'
<dependency org="com.anton-johansson" name="build-markdown-generator-core" rev="1.0.0">
  <artifact name="build-markdown-generator-core" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.anton-johansson', module='build-markdown-generator-core', version='1.0.0')
)
libraryDependencies += "com.anton-johansson" % "build-markdown-generator-core" % "1.0.0"
[com.anton-johansson/build-markdown-generator-core "1.0.0"]

Dependencies

compile (4)

Group / Artifact Type Version
commons-io : commons-io jar 2.5
org.apache.commons : commons-lang3 jar 3.6
com.fasterxml.jackson.dataformat : jackson-dataformat-xml jar 2.9.0.pr4
org.freemarker : freemarker jar 2.3.23

test (1)

Group / Artifact Type Version
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

Build Markdown Generator

Build Status License

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

com.anton-johansson

Viskan System AB

Versions

Version
1.0.0