Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/germanattanasio/jenkins-badges

:soccer: Express application that creates shield.io badges from Jenkins plugins.
https://github.com/germanattanasio/jenkins-badges

badge cobertura jacoco jenkins jenkins-jobs

Last synced: 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/germanattanasio/jenkins-badges
Owner: germanattanasio
Created: 2016-02-13T23:35:04.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2023-01-24T00:41:46.000Z (almost 2 years ago)
Last Synced: 2024-10-15T18:19:09.415Z (3 months ago)
Topics: badge, cobertura, jacoco, jenkins, jenkins-jobs
Language: JavaScript
Homepage:
Size: 529 KB
Stars: 4
Watchers: 0
Forks: 15
Open Issues: 12
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        # jenkins-badges

[![Build Status](https://travis-ci.org/germanattanasio/jenkins-badges.svg?branch=master)](http://travis-ci.org/germanattanasio/jenkins-badges)

[![codecov.io](https://codecov.io/github/germanattanasio/jenkins-badges/coverage.svg?branch=master)](https://codecov.io/github/germanattanasio/jenkins-badges?branch=master)

[![npm-version](https://img.shields.io/npm/v/jenkins-badges.svg)](https://www.npmjs.com/package/jenkins-badges)

[![npm-downloads](https://img.shields.io/npm/dm/jenkins-badges.svg)](https://www.npmjs.com/package/jenkins-badges)

[Express][express] application that creates [shield.io](http://shields.io/) badges from [Jenkins][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][jacoco]

- [Cobertura][cobertura]

- Request a new plugin [here](issues).

## Installation

```sh

$ 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**

      /jacoco/coverage?job=

**Cobertura**

      /cobertura/coverage?job=

Where: `` is the express app and `` is the Jenkins job.

## Tests

Running all the tests:

    $ npm test

Running a specific test:

    $ mocha -g ''

## License

MIT

## Contributing

See [CONTRIBUTING](https://github.com/germanattanasio/jenkins-badges/blob/master/CONTRIBUTING.md).

[express]: http://expressjs.com/

[jenkins]: https://jenkins-ci.org/

[jacoco]: http://eclemma.org/jacoco/

[cobertura]: http://cobertura.github.io/cobertura/

[issues]: https://github.com/germanattanasio/jenkins-badges/issues/new?labels=new-plugin&title=Add+support+for:

## Inspiration

- https://github.com/neoziro/jenkins-badge

- https://github.com/mnpk/jenkins-coverage-badge

- https://github.com/hbetts/jenkins-coverage-badge