https://github.com/anton-johansson/build-markdown-generator

Generates markdown for a build report, containing for example JUnit report, code coverage report, etc.
https://github.com/anton-johansson/build-markdown-generator

build checkstyle coverage jenkins junit markdown maven report

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/anton-johansson/build-markdown-generator
• Owner: anton-johansson
• License: apache-2.0
• Created: 2017-07-03T13:26:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-09-03T04:49:40.000Z (about 2 years ago)
• Last Synced: 2024-09-20T17:03:45.589Z (7 days ago)
• Topics: build, checkstyle, coverage, jenkins, junit, markdown, maven, report
• Language: Java
• Homepage:
• Size: 109 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Build Markdown Generator

[![Build Status](https://img.shields.io/travis/anton-johansson/build-markdown-generator/master.svg)](https://travis-ci.org/anton-johansson/build-markdown-generator)

[![License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://raw.githubusercontent.com/anton-johansson/build-markdown-generator/master/LICENSE)

Generates markdown for build reports, containing for example JUnit report, code coverage report, etc. A success example result can be found [here](./result-success.md) and a failure example result can be found [here](./result-failure.md).



## Supported reports

  * Checkstyle

  * Cobertura

  * JUnit

## Entry points

Also see the [samples](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 `v1.0.0` (would be nice if we could find [a Maven goal](https://github.com/mojohaus/versions-maven-plugin/pull/184) 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](https://github.com/anton-johansson)