Giter Club home page Giter Club logo

hudson-remote-cli's Introduction

Build Status

Hudson Remote Cli

hudson-remote-cli is ruby library to talk to Hudson's json remote access api

Installation

Add this line to your application's Gemfile:

gem install hudson-remote-cli

Configuration

require 'hudson-remote-cli'

# Manual Configuration
Hudson[:url] = 'http://localhost:8080'
Hudson[:user] = 'hudson'
Hudson[:password] = 'password'

Usage

Information for Hudson

# get all jobs
Hudson.jobs

# load statistics
Hudson.overallLoad

# get all infomation for hudson
Hudson.api

# just get job name and colors.
# For more of this see:_Controlling the amount of data you fetch_ in hudson help
# All api method can use like this
Hudson.api('jobs[name, color]')

# when you request the _api_ method, we'll cache the data default.
# you can specified the second param as true to clean the cache
Hudson.api('jobs[name, color]', true)

Information for Build Queue

# get build queue job names
Hudson::BuildQueue.list

# get full information of build queue
Hudson::BuildQueuq.api

Create a job

job = Hudson::Job.create('job_name', 'config.xml local path')

Actions and Informatons on job

# load existing job
j = Hudson::Job.new('job_name')

# enable the job
j.enable

# disable the job
j.disable

# is the job enable?
j.buildable?

# start a build
j.build

# start a build with params
j.build({'key1' => 'value1', 'key2' => 'value2', ...})

# is the job building
j.active?

# wait the job building complete
j.wait_for_build

# start a build and wait for it finish, also worked with params
j.build!

# description of the job
j.description

# set description of the job
j.description = 'some description'

# update the job
j.update('config.xml local path')

# delete the job
j.delete

# job name
j.name

# all information
j.api

# last build number
j.last_build

# last success build number
j.last_success_build

Information of a build

# get information on latest build
b = Hudson::Build.new('job_name')

# get information on particular build number
b = Hudson::Build.new('job_name', 142)

# get all informations of the build
b.api

# get build description
b.description

# set build description
b.description = 'some description'

# get the result of this build
b.result

# get commit revisions in this build
b.revisions

# build start time
b.start_time

# build end time
b.end_time

# build log
b.console

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

hudson-remote-cli's People

Contributors

guyzhangzhang avatar

Watchers

James Cloos avatar  avatar

hudson-remote-cli's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can image, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

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.