winci 0.0.2 → 0.0.3

data/{README.txt → README.md}

@@ -1,13 +1,12 @@
 winci
 ======
 
-[WinCI] Simplifies mplementation of a full continuous deployment pipeline the Agile way with Jenkins/Hudson continuous integration server under Windows.
+[WinCI] Simplifies implementation of a full continuous deployment pipeline the Agile way with Jenkins/Hudson continuous integration server under Windows.
 
 Install
 =======
 
     gem install winci
-	
 
 Introduction
 =======
@@ -20,26 +19,48 @@ only then is he introduced to some configuration options.
 
 WinCI is written in Ruby and uses Jenkins.rb gem to automate installation and interaction with Jenkins CI and also ruby-git gem to automate CI provisioning.
 
-WinCI is intended to be be used in conjunction with WinCI-server, which is another gem containing functionality necessary 
-to setup Jenkins CI and enabling to create installation bundle used in provisioning process.
+WinCI is intended to be used in conjunction with WinCI-server [https://github.com/ksob/winci-server] and WinCI-updater [https://github.com/ksob/winci-updater] projects.
 
+WinCI-server provides functionality necessary to setup Jenkins CI and enabling to create installation bundle used in provisioning process and WinCI-updater plays huge role in the provisioning process.
 
 Usage
 =====
 
-First download and run WinCI-server.
-Then you can start using this gem, first take a look at examples directory. 
-Keep in mind that so far this project is mostly a wrapper for functionality contained in Jenkins.rb gem,
-so if you would like to create nodes in Jenkins or create rake build steps then you should look at Jenkins.rb gem's docs or API file.
+First setup WinCI-server [https://github.com/ksob/winci-server]
+
+Then you can start using winci gem like this:
+
+	require 'rubygems'
+	require 'jenkins'
+	require 'winci'
+
+	project_name = 'my_project'
 
+	cfg = Jenkins::JobConfigBuilder.new(:ruby) do |c|
+	  c.scm = "C:/repos/#{project_name}.git"
+	  c.steps = [
+		# below makes sense when your Rakefile run rspec/cucumber by default
+		[:build_bat_step, "bundle exec rake"],
+		# this will send current code to production repo only after rspec/cucumber passed
+		[:build_bat_step, "git push c:/repos/production/#{project_name}.git HEAD:master"]
+	  ]
+	end
 
+	job = WinCI::Job.new project_name, cfg
+
+	# by default creates job on localhost:3010
+	puts job.create
+
+For details take a look at examples directory. 
+Keep in mind that so far this project is mostly a wrapper for functionality contained in Jenkins.rb gem,
+so if you would like to create nodes in Jenkins or create rake build steps then you should look at Jenkins.rb gem's docs or API file.
 
 License
 =======
 
 (The MIT License)
 
-Copyright (c) 2011 Kamil Sobieraj, ksob\at\rubyforge.org
+Copyright (c) 2011 Kamil Sobieraj, ksobej@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/examples/basic.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'jenkins'
 require 'winci'
 
@@ -6,14 +7,14 @@ project_name = 'files'
 cfg = Jenkins::JobConfigBuilder.new(:ruby) do |c|
   c.scm = "C:/repos/#{project_name}.git"
   c.steps = [
-      # below makes sense when your Rakefile run rspec/cucumber by default
+    # below makes sense when your Rakefile run rspec/cucumber by default
     [:build_bat_step, "bundle exec rake"],
     # this will send current code to production repo only after rspec/cucumber passed
-    [:build_bat_step, "git push c:/repos/production/files.git HEAD:master"]
+    [:build_bat_step, "git push c:/repos/production/#{project_name}.git HEAD:master"]
   ]
 end
 
 job = WinCI::Job.new project_name, cfg
 
 # by default creates job on localhost:3010
-job.create
+puts job.create

data/examples/extended.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'jenkins'
 require 'winci'
 
@@ -6,7 +7,7 @@ project_name = 'files'
 cfg = Jenkins::JobConfigBuilder.new(:ruby) do |c|
   c.scm = "C:/repos/#{project_name}.git"
   c.steps = [
-      # in this way we can ensure that the PATH is the same as in production environment
+    # in this way we can ensure that the PATH is the same as in production environment
     [:build_shell_step, "export PATH=C:/Ruby/bin;\r\n" + "echo PATH is now : $PATH"],
     # then we can run some installation script
     [:build_bat_step, "ruby install.rb"],
@@ -15,10 +16,10 @@ cfg = Jenkins::JobConfigBuilder.new(:ruby) do |c|
     # some adjustments to git before pushing
     [:build_bat_step, "git config core.hidedotfiles false"],
     # see basic.rb
-    [:build_bat_step, "git push c:/repos/production/files.git HEAD:master"]
+    [:build_bat_step, "git push c:/repos/production/#{project_name}.git HEAD:master"]
   ]
 end
 
 job = WinCI::Job.new project_name, cfg
 
-job.create '192.168.1.10', '3010'
+puts job.create '192.168.99.99', '3010'

data/examples/retrieving_info.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'winci'
 
 project_name = 'files'

data/lib/winci.rb

@@ -1,5 +1,4 @@
 module WinCI
   require 'winci/version'
   require 'winci/job'
-  require 'winci/build'
 end

data/lib/winci/version.rb

@@ -1,3 +1,3 @@
 module WinCI
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: winci
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Kamil Sobieraj
@@ -48,7 +48,7 @@ files:
 - Gemfile
 - History.txt
 - PostInstall.txt
-- README.txt
+- README.md
 - Rakefile
 - examples/basic.rb
 - examples/extended.rb