https://github.com/sippeangelo/jenkinshield

Node.js server that serves build status badges from Jenkins API
https://github.com/sippeangelo/jenkinshield

Last synced: about 2 months ago
JSON representation

Node.js server that serves build status badges from Jenkins API

• Host: GitHub
• URL: https://github.com/sippeangelo/jenkinshield
• Owner: sippeangelo
• Created: 2015-06-08T21:17:49.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-06-09T02:49:40.000Z (about 11 years ago)
• Last Synced: 2025-11-24T07:44:16.957Z (7 months ago)
• Language: JavaScript
• Size: 125 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# jenkinshield

Generate build status and test case badges from Jenkins builds with customizability.

Using [gh-badges](https://www.npmjs.com/package/gh-badges)

## Install

```

npm install -g jenkinshield

```

## Usage

```

  Usage: jenkinshield [options]

  Options:

    -h, --help           output usage information

    -V, --version        output the version number

    -u, --url       Jekins URL (http://username:password@server:port)

    -p, --port [number]  Port [2323]

```

Use the same URL to your build as Jenkins does, just change the port (if you happen to be running jenkinsshield on the same server).

### Build Status

```

http://server:2323/job//

http://server:2323/job//lastBuild

http://server:2323/job//lastStableBuild

http://server:2323/job//lastSuccessfulBuild

```

![ passing](https://img.shields.io/badge/%3Cyour%20job%3E-passing-brightgreen.svg) ![ unstable](https://img.shields.io/badge/%3Cyour%20job%3E-unstable-yellow.svg) ![ failing](https://img.shields.io/badge/%3Cyour%20job%3E-failing-red.svg)

### Test Results

```

http://server:2323/job///testReport?text=tests

http://server:2323/job//lastBuild/testReport?text=tests

http://server:2323/job//lastStableBuild/testReport?text=tests

http://server:2323/job//lastSuccessfulBuild/testReport?text=tests

```

![tests 10 / 10](https://img.shields.io/badge/tests-10%20/%2010-brightgreen.svg) ![tests 9 / 10](https://img.shields.io/badge/tests-9%20/%2010-red.svg)

## Customize

The server accepts a few query strings that allow you to customize your badge.

| Parameter | Values                      | Description                                                             |

|-----------|-----------------------------|-------------------------------------------------------------------------|

| text      | any                         | Replaces the text on the badge. Default is the display name of the job. |

| template  | plastic, flat, flat-squared | Changes theme of the badge.                                             |

## Examples

```

http://server:2323/job//lastBuild

```

![build passing](https://img.shields.io/badge/build-passing-brightgreen.svg)

```

http://server:2323/job//lastBuild/testReport?text=tests&theme=plastic

```

![tests 10 / 10](https://img.shields.io/badge/tests-10%20%2F%2010-brightgreen.svg?style=plastic)