Project

jenkins-status-tool

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
jenkins-status-toolkontera-technologies/jenkins-status-toolHomepageDocumentationSource CodeBug TrackerWiki
Small tool to get the build status from Jenkins. Useful for embedding Jenkins CI status images on your Github project.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
17,246
Stars
8
Forks
1
Watchers
15
 Releases
Current version
0.0.8
Total releases
5
First release
2012-04-05
Latest release
2012-06-18
 Development
Primary Language
Ruby
Average date of last 50 commits
2012-03-19
Reverse Dependencies
0

 Dependencies

Runtime

json
>= 0
sinatra
>= 0
 Project Readme

The Jenkins Status Tool

Small tool to get the build status from Jenkins. Useful for embedding Jenkins CI status images on your Github project.

API

	</tr>

		<tr>
			<td align=center><b>GET</b></td>
			<td>/project/:project_id/status.png</td>
			<td>Get project status image</td>
			<td>
				<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/public/images/pass.png"><br/>
				<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/public/images/fail.png"><br/>
				<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/public/images/unknown.png">					
			</td>
		</tr>
		
		<tr>
			<td align=center><b>GET</b></td>
			<td>/project/:project_id/rcov.png</td>
			<td>Get project rcov graph image</td>
			<td>
				<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/readme-files/rcov.png"><br/>
			</td>
			
		</tr>
		

	</tbody>
Method Action Info Examples
GET /project/:project_id/status.json Get project status json string {"status":"pass"}
{"status":"fail"}
{"status":"unknown"}

Installation

RubyGems.org

gem install jenkins-status-tool

Source

[root@far-away] git clone git@github.com:kontera-technologies/jenkins-status-tool.git
[root@far-away] bundle install
[root@far-away] bundle exec rake install

Usage

after installing the gem, the jenkins-status-tool command should be available

[root@far-away] jenkins-status-tool --help

The Jenkins Status Tool
Usage: jenkins-status-tool [options]

Options:
    -j, --jenkins URL                Jenkins url, e.g http://jenkins:8080, default is localhost
    -p, --port URL                   listening port, default is 7676
    -d, --daemonize                  run in background
    -P, --pid-file FILE              pid file, default /var/run/jenkins-status-tool.pid
    -s, --https                      use this if running behind https forwarder (e.g stunnel)

More Info:
https://github.com/kontera-technologies/jenkins-status-tool

Example

lets say that our Jenkins server is running on jenkins-server:1234

[root@far-away] jenkins-status-tool --jenkins jenkins-server:1234 --port 5555 --daemonize
[root@far-away] curl http://localhost:5555/project/my-project/status.json
{"status":"pass"}
[root@far-far-away] wget http://localhost:5555/project/my-project/status.png
[...SHOULD DOWNLOAD ONE OF THE IMAGES ABOVE...]

Embed it

you can easily embed the current status of your builds in any html type document.

HTML

<img src="https://jenkins-status-tool-url/project/PROJECT-NAME/status.png"/>

TextLite

"!https://jenkins-status-tool-url/project/PROJECT-NAME/status.png!":http://jenkins.example.com/jobs/PROJET-NAME

RDoc

{<img src="https://jenkins-status-tool-url/project/PROJECT-NAME/status.png" />}[http://jenkins.example.com/jobs/PROJET-NAME]

MarkDown

[![Build Status](https://jenkins-status-tool-url/project/PROJECT-NAME/status.png)](http://jenkins.example.com/jobs/PROJET-NAME)

The tunnel... We used STunnel to route jenkins-status-tool-url:443 <=> jenkins-status-tool-url:5555 This allow us to fetch the status images using https.

Credits