Code Monkey home page Code Monkey logo

jenkins-remote-api's Introduction

Jenkins Remote API

A gem aims at help you consume remote-access-api offered by Jenkins.

Why

The Jenkins exposes three kinds of api(xml/json/python) to outside users. And we might ask why we need to consume those data?

Well, for a large team(over 6~8 people), how to visualize the ci process status is very important. In opposite to the way that you manually go to Jenkins website and see the build status(positive), what if we can utilize Kanban methodology.That is to have a screen to show current ci status(passive but with knowledge radiation). Red means failure; Green means good/success;Blue means building in process.Maybe in further, we can buy The Hudson Bear Lamps to show build status.

But the prerequisite is that you need to consume the raw data offered by Jenkins api. So this gem will wrap around the raw api from Jenkins, let you make best of it to do thing better.

The following markups are supported. The dependencies listed are required if you wish to run the library.

Installation

gem install jenkins-remote-api

How to use

###Commands from terminal Yes, this gem use CLI(using Aruba) to add command line interface so that you can fire it up directly in terminal(cool). If you just want to play around with it, you probably don't even need to go to crazy "IRB" console^_^.

  • jenkins -h -- It will come up with help message.
  • jenkins list_all_job_names --ci_address http://ci.jruby.org/view/Ruboto/ -- It will list all jobs'name on Jenkins.
  • jenkins jobs_description --ci_address http://ci.jruby.org/view/Ruboto/ -- It will list all jobs description(name,url,status) on Jenkins.
  • jenkins current_status --job_name ruboto-core --ci_address http://ci.jruby.org/view/Ruboto/ -- It will list current building status of job you identified on Jenkins.

####Usage in irb console require 'rubygems' require 'jenkins-remote-api' jenkins = Ci::Jenkins.new("http://ci.jruby.org/view/Ruboto/") jenkins.list_all_job_names jenkins.jobs_description jenkins.current_status_on_job "ruboto-core" job = jenkins.job_named "ruboto-core"

Contribute

Want to contribute? Email to: [email protected]

jenkins-remote-api's People

Contributors

tuo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

jenkins-remote-api's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.