jenkins-capistrano 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08e7f0caa243bf076670aee6c701dea64f471263
+  data.tar.gz: c4bf4f53e44317c8c51d503e6d68343a5deeb05f
+SHA512:
+  metadata.gz: 42bf4c7d1b3d24563f8844bcfe553116c464260748aa403bd4bd63b2c6eef2b71f93ed5cdeb478c0e3a805e2b7ce055f4829f8cef31e41cefe78d5d50195c7c0
+  data.tar.gz: a4af671c54adbeb70e9c624eef73b057f44aef1c9b0ac4b7200507defbea1daffea715cf1646d2fb25f6328fedc6b64dae6db1970052fb720eb7e803d634407e

data/README.md

@@ -0,0 +1,218 @@
+# jenkins-capistrano
+
+The capistrano tasks for Jenkins CI Server. Supports to manage following things:
+
+* Job
+* Node
+* View
+* Plugins(Experimental)
+
+## Installation
+
+Add this line to your application's Gemfile::
+
+  gem 'jenkins-capistrano'
+
+And then execute::
+
+  $ bundle
+
+Or install it yourself as::
+
+  $ gem install jenkins-capistrano
+
+## Example
+
+See [example directory](https://github.com/cynipe/jenkins-capistrano/tree/develop/example>) or following instructions.
+
+### Job Configuration
+
+The following code will creates or updates Jenkins jobs before each deploy task:
+
+config directory structure(name your config.xml as a job name):
+```
+config
+├── deploy.rb
+└── jenkins
+     └── jobs
+         ├── job-name1.xml
+         ├── job-name2.xml
+         └── job-name3.xml
+```
+
+deploy.rb:
+```ruby
+set :application, "your-awesome-app"
+set :scm, :git
+set :repository,  "https://github.com/your/repository.git"
+
+set :jenkins_host, 'http://localhost:8080'
+#set :jenkins_username, '' # default empty
+#set :jenkins_password, '' # default empty
+#set :jenkins_job_config_dir, 'config/jenkins/jobs'
+
+before 'deploy', 'jenkins:deploy_jobs'
+```
+
+#### Want to disabling some jobs for specific environment?
+
+Since 0.0.5, you can disabling jobs using `disabled_jobs` option.
+Use this option with [multistage-extension](<https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension>).
+
+Put the following line into `config/deploy/<env>.rb`:
+```
+set :disabled_jobs, %w(job1 job2)
+```
+
+
+### Node Configuration
+
+config directory structure(name your json file as a node name):
+```
+config
+├── deploy.rb
+└── jenkins
+     └── nodes
+         ├── node1.json
+         ├── node2.json
+         └── node3.json
+```
+
+sample node configuration:
+```json
+{
+  "name"        : "example",
+  "type"        : "hudson.slaves.DumbSlave$DescriptorImpl",
+  "description" : "some description",
+  "executors"   : 2,
+  "labels"      : "linux, java, ruby",
+  "slave_host"  : "example.com",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "slave_fs"    : "/home/jenkins",
+  "exclusive"   : true,
+  "java_path": "/opt/java/bin/java",
+  "jvm_options": "-Xmx512M",
+  "env_vars": {
+    "key1": "val1",
+    "key2": "val2"
+  }
+}
+```
+
+deploy.rb:
+```ruby
+set :application, "your-awesome-app"
+set :scm, :git
+set :repository,  "https://github.com/your/repository.git"
+
+set :jenkins_host, 'http://localhost:8080'
+# set :jenkins_username, '' # default empty
+# set :jenkins_password, '' # default empty
+# set :jenkins_node_config_dir, 'config/jenkins/nodes'
+
+before 'deploy', 'jenkins:config_nodes'
+```
+
+### View Configuration
+
+config directory structure(name your json file as a node name):
+```
+config
+├── deploy.rb
+└── jenkins
+     └── views
+         ├── view1.xml
+         ├── view2.xml
+         └── view3.xml
+```
+
+sample view configuration:
+```xml
+<listView>
+  <name>view1</name>
+  <filterExecutors>false</filterExecutors>
+  <filterQueue>false</filterQueue>
+  <properties class="hudson.model.View$PropertyList"/>
+  <jobNames class="tree-set">
+    <comparator class="hudson.util.CaseInsensitiveComparator" reference="../../../hudson.plugins.view.dashboard.Dashboard/jobNames/comparator"/>
+  </jobNames>
+  <jobFilters/>
+  <columns>
+    <hudson.views.StatusColumn/>
+    <hudson.views.WeatherColumn/>
+    <hudson.views.JobColumn/>
+    <hudson.views.LastSuccessColumn/>
+    <hudson.views.LastFailureColumn/>
+    <hudson.views.LastDurationColumn/>
+    <hudson.views.BuildButtonColumn/>
+  </columns>
+  <includeRegex>job.*</includeRegex>
+</listView>
+```
+
+deploy.rb:
+```ruby
+set :application, "your-awesome-app"
+set :scm, :git
+set :repository,  "https://github.com/your/repository.git"
+
+set :jenkins_host, 'http://localhost:8080'
+# set :jenkins_username, '' # default empty
+# set :jenkins_password, '' # default empty
+# set :jenkins_node_config_dir, 'config/jenkins/nodes'
+
+before 'deploy', 'jenkins:config_views'
+```
+
+#### Don't know how to write config.xml for view?
+
+Create or configure the view you want to manage via usual operation through the Jenkins UI.
+Then, open the `JENKINS_HOME/config.xml` and copy the desired configuration from `<views>` section, and
+ommit `<owner class="hudson" reference="../../.."/>` line.
+
+### Plugin Configuration(experimental)
+
+#### Note
+
+This feature is may change its API without any notice.
+Use at your own risk.
+
+deploy.rb:
+```ruby
+set :application, "your-awesome-app"
+set :scm, :git
+set :repository,  "https://github.com/your/repository.git"
+
+set :jenkins_plugins, %w(cron_column envinject join)
+# you can specify version as follows:
+#set :jenkins_plugins, %w(cron_column@1.1.2 envinject join@1.0.0)
+set :jenkins_install_timeout, 60 * 5      # default: 5min
+set :jenkins_plugin_enable_update, false  # dafault: false
+set :jenkins_plugin_enable_restart, false # default: false
+
+before 'deploy', 'jenkins:install_plugins'
+```
+
+## Release Notes
+
+### 0.0.7
+  * Fix disable_job is not working with recent version of Jenkins ([#9](https://github.com/cynipe/jenkins-capistrano/pull/9))
+
+### 0.0.6
+  * Support view management ([726ad3ef](<https://github.com/cynipe/jenkins-capistrano/commit/726ad3ef817ba15a2d66503ce0dd4bc961ed92e2))
+  * Support plugin management(Experimental) ([4d9964c0](https://github.com/cynipe/jenkins-capistrano/commit/4d9964c00ff95798915484ceb8b5c837b2aa03e8))
+
+### 0.0.5.2
+  * Fix cgi library loading error
+
+## 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
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/e76247570c952ad3205ca7d6d3f0f7b5 "githalytics.com")](http://githalytics.com/cynipe/jenkins-capistrano)

data/example/.gitignore

@@ -0,0 +1,4 @@
+tmp/
+.bundle/
+.librarian/
+

data/example/Capfile

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'capistrano_colors'
+require 'capistrano/ext/multistage'
+require 'railsless-deploy'
+require 'jenkins-capistrano'
+
+default_run_options[:pty] = true
+load 'config/deploy'
+

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'railsless-deploy'
+gem 'jenkins-capistrano'

data/example/README.md

@@ -0,0 +1,32 @@
+# jenkins-capistrano example
+
+jenkins-capistranoを使って、master-slave構成のJenkinsに以下のことを行う設定例
+
+* バッチで必要なジョブ
+* バッチを実際に実行するためのスレーブノードの登録
+* バッチプログラム(binディレクトリ)のデプロイ
+
+## 前提
+
+* ローカルにruby1.8.7+が入っていること
+* 各スレーブノードに`/opt/hello`ディレクトリがあること
+* `/opt/hello`ディレクトリにjenkinsユーザが書き込み権限があること
+* jenkinsユーザがマスターノードからスレーブノードに公開鍵認証で接続できること
+
+## デプロイの仕方
+
+本番環境:
+```
+$ script/deploy production
+```
+
+ステージング環境:
+```
+$ script/deploy staging
+```
+
+開発環境:
+```
+$ script/deploy
+```
+

data/example/bin/hello

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo 'hello'

data/example/config/deploy.rb

@@ -0,0 +1,35 @@
+set :application, 'hello'
+set :repository, 'http://example.org/your/repository.git'
+set :scm, :git
+set :branch, 'develop' # デフォルトブランチの設定
+set :deploy_via, :copy # ローカルクローンしてリモートにコピー(リモートでクローンしないように)
+set :deploy_to, "/opt/#{application}"
+set :use_sudo, false
+set :keep_releases, 5
+
+set :stages, %w(develop staging production)
+set :default_stage, 'develop'
+
+set :user, 'jenkins'
+# 公開鍵認証を推奨
+#set :password do
+#  ENV['DEPLOY_PASSWORD'] || Capistrano::CLI.password_prompt("linux user password[#{user}]: ")
+#end
+
+set :jenkins_username, user
+# 必要であれば
+#set :jenkins_password do
+#  ENV['DEPLOY_PASSWORD'] || Capistrano::CLI.password_prompt("jenkins server password[#{user}]: ")
+#end
+
+before 'deploy', 'deploy:check'
+after  'deploy', 'jenkins:deploy_jobs'
+after  'deploy', 'jenkins:deploy_jobs'
+after  'deploy', 'deploy:cleanup'
+
+# ローカルにgitコマンドがあること
+depend :local, :command, 'git'
+# リモートにデプロイ用ディレクトリがあること
+depend :remote, :directory, deploy_to
+# jenkinsユーザで書き込みができること
+depend :remote, :writable, deploy_to

data/example/config/deploy/develop.rb

@@ -0,0 +1,5 @@
+# ブランチはconfig/deploy.rbの設定に従う
+role :batch, 'dev-slave01.local'
+set :jenkins_host, 'dev-master.local'
+set :jenkins_node_config_dir, 'config/jenkins/nodes/develop'
+

data/example/config/deploy/production.rb

@@ -0,0 +1,9 @@
+set :branch, 'v1.0.0'
+
+role :batch, 'prod-slave01.local'
+# 複数ノードの場合
+#role :batch, 'prod-slave02.local'
+#role :batch, 'prod-slave03.local'
+
+set :jenkins_host, 'prod-master.local'
+set :jenkins_node_config_dir, 'config/jenkins/nodes/production'

data/example/config/deploy/staging.rb

@@ -0,0 +1,10 @@
+set :branch, 'release/1.0.1'
+
+role :batch, 'stg-slave01.local'
+# 複数ノードの場合
+#role :batch, 'stg-slave02.local'
+#role :batch, 'stg-slave03.local'
+
+set :jenkins_host, 'stg-master.local'
+set :jenkins_node_config_dir, 'config/jenkins/nodes/staging'
+

data/example/config/jenkins/jobs/hello.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?><project>
+  <actions/>
+  <description/>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <scm class="hudson.scm.NullSCM"/>
+  <canRoam>true</canRoam>
+  <disabled>false</disabled>
+  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <jdk>Default</jdk>
+  <triggers class="vector">
+    <hudson.triggers.TimerTrigger>
+      <spec>0 8 * * *</spec>
+    </hudson.triggers.TimerTrigger>
+  </triggers>
+  <concurrentBuild>false</concurrentBuild>
+  <builders>
+    <hudson.tasks.Shell>
+      <command>cd /opt/hello/current &amp;&amp; bin/hello</command>
+    </hudson.tasks.Shell>
+  </builders>
+  <publishers>
+    <hudson.tasks.Mailer>
+      <recipients>opsadmin@example.com</recipients>
+      <dontNotifyEveryUnstableBuild>false</dontNotifyEveryUnstableBuild>
+      <sendToIndividuals>false</sendToIndividuals>
+    </hudson.tasks.Mailer>
+  </publishers>
+</project>

data/example/config/jenkins/nodes/develop/dev-slave01.json

@@ -0,0 +1,17 @@
+{
+  "description" : "Slave1",
+  "slave_fs"    : "/home/jenkins",
+  "executors"   : 5,
+  "exclusive"   : true,
+  "labels"      : "hello",
+  "slave_host"  : "dev-slave01.local",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "jvm_options" : "-Dfile.encoding=UTF-8",
+  "env_vars": {
+    "LANG"            : "ja_JP.UTF-8",
+    "ENVIRONMENT"     : "production",
+  }
+}
+

data/example/config/jenkins/nodes/production/prod-slave01.json

@@ -0,0 +1,17 @@
+{
+  "description" : "Slave1",
+  "slave_fs"    : "/home/jenkins",
+  "executors"   : 5,
+  "exclusive"   : true,
+  "labels"      : "hello",
+  "slave_host"  : "prod-slave01.local",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "jvm_options" : "-Dfile.encoding=UTF-8",
+  "env_vars": {
+    "LANG"            : "ja_JP.UTF-8",
+    "ENVIRONMENT"     : "production",
+  }
+}
+

data/example/config/jenkins/nodes/production/prod-slave02.json

@@ -0,0 +1,17 @@
+{
+  "description" : "Slave1",
+  "slave_fs"    : "/home/jenkins",
+  "executors"   : 5,
+  "exclusive"   : true,
+  "labels"      : "hello",
+  "slave_host"  : "prod-slave02.local",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "jvm_options" : "-Dfile.encoding=UTF-8",
+  "env_vars": {
+    "LANG"            : "ja_JP.UTF-8",
+    "ENVIRONMENT"     : "production",
+  }
+}
+

data/example/config/jenkins/nodes/production/prod-slave03.json

@@ -0,0 +1,17 @@
+{
+  "description" : "Slave1",
+  "slave_fs"    : "/home/jenkins",
+  "executors"   : 5,
+  "exclusive"   : true,
+  "labels"      : "hello",
+  "slave_host"  : "prod-slave03.local",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "jvm_options" : "-Dfile.encoding=UTF-8",
+  "env_vars": {
+    "LANG"            : "ja_JP.UTF-8",
+    "ENVIRONMENT"     : "production",
+  }
+}
+

data/example/config/jenkins/nodes/staging/stg-slave01.json

@@ -0,0 +1,17 @@
+{
+  "description" : "Slave1",
+  "slave_fs"    : "/home/jenkins",
+  "executors"   : 5,
+  "exclusive"   : true,
+  "labels"      : "hello",
+  "slave_host"  : "stg-slave01.local",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "jvm_options" : "-Dfile.encoding=UTF-8",
+  "env_vars": {
+    "LANG"            : "ja_JP.UTF-8",
+    "ENVIRONMENT"     : "staging",
+  }
+}
+

data/example/config/jenkins/nodes/staging/stg-slave02.json

@@ -0,0 +1,17 @@
+{
+  "description" : "Slave2",
+  "slave_fs"    : "/home/jenkins",
+  "executors"   : 5,
+  "exclusive"   : true,
+  "labels"      : "hello",
+  "slave_host"  : "stg-slave02.local",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "jvm_options" : "-Dfile.encoding=UTF-8",
+  "env_vars": {
+    "LANG"            : "ja_JP.UTF-8",
+    "ENVIRONMENT"     : "staging",
+  }
+}
+

data/example/config/jenkins/nodes/staging/stg-slave03.json

@@ -0,0 +1,17 @@
+{
+  "description" : "Slave3",
+  "slave_fs"    : "/home/jenkins",
+  "executors"   : 5,
+  "exclusive"   : true,
+  "labels"      : "hello",
+  "slave_host"  : "stg-slave03.local",
+  "slave_port"  : 22,
+  "slave_user"  : "jenkins",
+  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
+  "jvm_options" : "-Dfile.encoding=UTF-8",
+  "env_vars": {
+    "LANG"            : "ja_JP.UTF-8",
+    "ENVIRONMENT"     : "staging",
+  }
+}
+

data/example/script/bootstrap

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+set -e
+
+(gem spec bundler -v '~> 1.2.0' > /dev/null 2>&1) || gem install bundler -v '~> 1.2.0' --no-rdoc --no-ri
+
+# 常に綺麗な設定で行うように
+rm -rf .bundle/config
+bundle install --binstubs .bundle/bin --path .bundle
+

data/example/script/deploy

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+script/bootstrap || exit 1
+bundle exec cap "$@" deploy

data/lib/jenkins-capistrano/client/job.rb

@@ -27,7 +27,7 @@ module Jenkins
 
       def disable_job(name)
         res = self.class.post("/job/#{CGI.escape(name)}/disable")
-        raise ServerError, parse_error_message(res) unless res.code.to_i == 200
+        raise ServerError, parse_error_message(res) unless res.code.to_i == 200 || res.code.to_i == 302
       rescue => e
         raise ServerError, "Failed to create job: #{name}, make sure you have specified auth info properly"
       end

data/lib/jenkins-capistrano/version.rb

@@ -1,5 +1,5 @@
 module Jenkins
   module Capistrano
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: jenkins-capistrano
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - cynipe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,49 +41,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hpricot
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: The capistrano tasks for Jenkins CI Server
@@ -101,8 +90,28 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
-- README.rst
+- README.md
 - Rakefile
+- example/.gitignore
+- example/Capfile
+- example/Gemfile
+- example/README.md
+- example/bin/hello
+- example/config/deploy.rb
+- example/config/deploy/develop.rb
+- example/config/deploy/production.rb
+- example/config/deploy/staging.rb
+- example/config/jenkins/jobs/.gitkeep
+- example/config/jenkins/jobs/hello.xml
+- example/config/jenkins/nodes/develop/dev-slave01.json
+- example/config/jenkins/nodes/production/prod-slave01.json
+- example/config/jenkins/nodes/production/prod-slave02.json
+- example/config/jenkins/nodes/production/prod-slave03.json
+- example/config/jenkins/nodes/staging/stg-slave01.json
+- example/config/jenkins/nodes/staging/stg-slave02.json
+- example/config/jenkins/nodes/staging/stg-slave03.json
+- example/script/bootstrap
+- example/script/deploy
 - jenkins-capistrano.gemspec
 - lib/jenkins-capistrano.rb
 - lib/jenkins-capistrano/client.rb
@@ -114,27 +123,25 @@ files:
 - lib/jenkins-capistrano/version.rb
 homepage: https://github.com/cynipe/jenkins-capistrano
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ''
 test_files: []
-has_rdoc: 

data/README.rst

@@ -1,216 +0,0 @@
-==================
-jenkins-capistrano
-==================
-
-The capistrano tasks for Jenkins CI Server. Supports to manage following things:
-
-* Job
-* Node
-* View
-* Plugins(Experimental)
-
-Installation
-============
-
-Add this line to your application's Gemfile::
-
-  gem 'jenkins-capistrano'
-
-And then execute::
-
-  $ bundle
-
-Or install it yourself as::
-
-  $ gem install jenkins-capistrano
-
-Example
-=======
-
-Job Configuration
-~~~~~~~~~~~~~~~~~
-
-The following code will creates or updates Jenkins jobs before each deploy task:
-
-config directory structure(name your config.xml as a job name)::
-
-  config
-  ├── deploy.rb
-  └── jenkins
-       └── jobs
-           ├── job-name1.xml
-           ├── job-name2.xml
-           └── job-name3.xml
-
-
-deploy.rb::
-
-  set :application, "your-awesome-app"
-  set :scm, :git
-  set :repository,  "https://github.com/your/repository.git"
-
-  set :jenkins_host, 'http://localhost:8080'
-  # set :jenkins_username, '' # default empty
-  # set :jenkins_password, '' # default empty
-  # set :jenkins_job_config_dir, 'config/jenkins/jobs'
-
-  before 'deploy', 'jenkins:deploy_jobs'
-
-Want to disabling some jobs for specific environment?
------------------------------------------------------
-
-Since 0.0.5, you can disabling jobs using `disabled_jobs` option.
-Use this option with `multistage-extension <https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension>`_.
-
-Put the following line into `config/deploy/<env>.rb`::
-
-  set :disabled_jobs, %w(job1 job2)
-
-
-Node Configuration
-~~~~~~~~~~~~~~~~~~
-
-config directory structure(name your json file as a node name)::
-
-  config
-  ├── deploy.rb
-  └── jenkins
-       └── nodes
-           ├── node1.json
-           ├── node2.json
-           └── node3.json
-
-sample node configuration::
-
-  {
-    "name"        : "example",
-    "type"        : "hudson.slaves.DumbSlave$DescriptorImpl",
-    "description" : "some description",
-    "executors"   : 2,
-    "labels"      : "linux, java, ruby",
-    "slave_host"  : "example.com",
-    "slave_port"  : 22,
-    "slave_user"  : "jenkins",
-    "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
-    "slave_fs"    : "/home/jenkins",
-    "exclusive"   : true,
-    "java_path": "/opt/java/bin/java",
-    "jvm_options": "-Xmx512M",
-    "env_vars": {
-      "key1": "val1",
-      "key2": "val2"
-    }
-  }
-
-deploy.rb::
-
-  set :application, "your-awesome-app"
-  set :scm, :git
-  set :repository,  "https://github.com/your/repository.git"
-
-  set :jenkins_host, 'http://localhost:8080'
-  # set :jenkins_username, '' # default empty
-  # set :jenkins_password, '' # default empty
-  # set :jenkins_node_config_dir, 'config/jenkins/nodes'
-
-  before 'deploy', 'jenkins:config_nodes'
-
-View Configuration
-~~~~~~~~~~~~~~~~~~
-
-config directory structure(name your json file as a node name)::
-
-  config
-  ├── deploy.rb
-  └── jenkins
-       └── views
-           ├── view1.xml
-           ├── view2.xml
-           └── view3.xml
-
-sample view configuration::
-
-    <listView>
-      <name>view1</name>
-      <filterExecutors>false</filterExecutors>
-      <filterQueue>false</filterQueue>
-      <properties class="hudson.model.View$PropertyList"/>
-      <jobNames class="tree-set">
-        <comparator class="hudson.util.CaseInsensitiveComparator" reference="../../../hudson.plugins.view.dashboard.Dashboard/jobNames/comparator"/>
-      </jobNames>
-      <jobFilters/>
-      <columns>
-        <hudson.views.StatusColumn/>
-        <hudson.views.WeatherColumn/>
-        <hudson.views.JobColumn/>
-        <hudson.views.LastSuccessColumn/>
-        <hudson.views.LastFailureColumn/>
-        <hudson.views.LastDurationColumn/>
-        <hudson.views.BuildButtonColumn/>
-      </columns>
-      <includeRegex>job.*</includeRegex>
-    </listView>
-
-deploy.rb::
-
-  set :application, "your-awesome-app"
-  set :scm, :git
-  set :repository,  "https://github.com/your/repository.git"
-
-  set :jenkins_host, 'http://localhost:8080'
-  # set :jenkins_username, '' # default empty
-  # set :jenkins_password, '' # default empty
-  # set :jenkins_node_config_dir, 'config/jenkins/nodes'
-
-  before 'deploy', 'jenkins:config_views'
-
-
-Don't know how to write config.xml for view?
---------------------------------------------
-
-Create or configure the view you want to manage via usual operation through the Jenkins UI.
-Then, open the `JENKINS_HOME/config.xml` and copy the desired configuration from `<views>` section, and
-ommit `<owner class="hudson" reference="../../.."/>` line.
-
-Plugin Configuration(experimental)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Note
-----
-
-This feature is may change its API without any notice.
-Use at your own risk.
-
-deploy.rb::
-
-  set :application, "your-awesome-app"
-  set :scm, :git
-  set :repository,  "https://github.com/your/repository.git"
-
-  set :jenkins_plugins, %w(cron_column envinject join)
-  # you can specify version as follows:
-  # set :jenkins_plugins, %w(cron_column@1.1.2 envinject join@1.0.0)
-  set :jenkins_install_timeout, 60 * 5      # default: 5min
-  set :jenkins_plugin_enable_update, false  # dafault: false
-  set :jenkins_plugin_enable_restart, false # default: false
-
-  before 'deploy', 'jenkins:install_plugins'
-
-Release Notes
-=============
-
-0.0.6
-  * Support view management (`726ad3ef <https://github.com/cynipe/jenkins-capistrano/commit/726ad3ef817ba15a2d66503ce0dd4bc961ed92e2>`_)
-  * Support plugin management(Experimental) (`4d9964c0 <https://github.com/cynipe/jenkins-capistrano/commit/4d9964c00ff95798915484ceb8b5c837b2aa03e8>`_)
-
-0.0.5.2
-  * Fix cgi library loading error
-
-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