README.md

jenkins-badges

Express application that creates shield.io badges from Jenkins plugins.

Live demo

http://jenkins-badges.mybluemix.net/

Note: If your jenkins is running behind a firewall or in a VPN you will need to won't be able to use the live demo.

Supported Plugins

• JaCoCo
• Cobertura
• Request a new plugin here.

Installation

$ npm install jenkins-badges -g

Usage

# Run with port number (default: 3000)
$ PORT=3000 jbadges
Server running on port: 3000

To generate a badge you need the Jenkins job url.

JaCoCo

  <application-url>/jacoco/coverage?job=<job-url>

Cobertura

  <application-url>/cobertura/coverage?job=<job-url>

Where: <application-url> is the express app and <job-url> is the Jenkins job.

Tests

Running all the tests:

$ npm test

Running a specific test:

$ mocha -g '<test name>'

License

MIT

Contributing

See CONTRIBUTING.

Inspiration

• https://github.com/neoziro/jenkins-badge
• https://github.com/mnpk/jenkins-coverage-badge
• https://github.com/hbetts/jenkins-coverage-badge