jenkins-builder 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b39898848784b84c87559eb63675f51dc4a03823ee35fe2da7dd749edd5d621c
-  data.tar.gz: 39212caecea142e17c80df6d37f94d4494bb30d0694059a983b17e50939c6181
+  metadata.gz: 6c813b09240b209488d82b385f69cb489ae98f76351d776e58b90d9e93eeb0ff
+  data.tar.gz: d9caa5b73d0b1c4659f380ae2ee396f92aca5e09cf6817ed3ab56b0e572627b0
 SHA512:
-  metadata.gz: 8cd027c6c46a93b6478e2fa9aed14f5032843a4d9661ed86ee9332c11acf6ad1af083a0aed72ac52c271989213a3fc14820a9f093f02740554a656e83e0cfc36
-  data.tar.gz: c8edb12b96dfdf9ec8e74e445632175c75316bb98113d4b0a74bbb4078d1fa30f6a663a92ff0b56bfec6d1d481009747c8875a28f72c3c41e92202323c221706
+  metadata.gz: bafb2136d76372bce62819f039ade1ee939d60cd802a82f9ca8228d50e109d2ede033835fcb309ac39a907d3a2d2cf631522e4ad2e45e658b070d9555045143b
+  data.tar.gz: 83fab1b1f53c99fdb8834d4677a66094bd122a22ff89b0322b19899d4ac24a8540c048242c33d50f2c18c41225c94f3a4980435a913d5ff3c87bd834be843750

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jenkins-builder (0.1.1)
+    jenkins-builder (0.1.2)
       jenkins_api_client (~> 1.5.3)
       pastel (~> 0.7.2)
       security (~> 0.1.3)

data/README.md

@@ -4,12 +4,16 @@
 
 ## Requirements
 
-  1. The gem use macOS KeyChain for managing credentials for logging into jenkins website, so macOS is the only supported OS by now.
+  1. This gem uses macOS KeyChain for managing credentials for logging into jenkins website, so macOS is the only supported OS by now.
   2. It use the `fzf` fuzzy selecting utility to filter jenkins job names and git branches, so before using this gem, you should install `fzf` first: `brew install fzf`.
 
 ## Installation
 
     $ gem install jenkins-builder
+    
+If any permission errors occurs, prepend `sudo`:
+
+    $ sudo gem install jenkins-builder
 
 ## Usage
 
@@ -19,9 +23,9 @@
     
 ### Setup
 
-All configuration is stored in `$HOME/.jenkins-builder.yaml` except password.
+All configuration stores in `$HOME/.jenkins-builder.yaml` except password.
 
-Password is stored in macOS KeyChain, its service name is `jenkins-builder-credentials`.
+Password stores in macOS KeyChain, KeyChain service name is `jenkins-builder-credentials`.
 
 #### Setup URL and credentials interactively
 
@@ -31,7 +35,7 @@ Just run: `$ jk setup`
 
     $ jk info
     
-By default, it does now show password, but if you want it: `$ jk info -p`
+By default, password will not be shown, but if you want:  `$ jk info -p`
 
 #### Edit config file directly
 
@@ -42,6 +46,12 @@ By default, it does now show password, but if you want it: `$ jk info -p`
 #### Specify job identifiers as command line arguments
 
     $ jk build project1 project2 ...
+    
+#### Fail-Fast
+
+If multiple jobs are specified, all jobs will be built by default. If yout wanna cancel all subsequent jobs after some job failed, use `-f` option of `build` command:
+
+    # jk build -f project1 project2 ...
 
 #### Specify git brand if you use mbranch plugin
 
@@ -57,17 +67,17 @@ Just run `jk build` without job identifiers specified as command line arguments:
 
     $ jk build
 
-Even just (because `build` is the default task):
+Or even just (because `build` is the default task):
 
     $ jk
 
 ### Alias
 
-For most working jobs, you can create aliases for them for convenice.
+For most common used jobs, you can create aliases for them for convenience.
 
 #### Create an alias
 
-    $ jk alias p1 project1:origin/develop
+    $ jk alias p1 'build project1:origin/develop'
 
 then you could just run:
 

data/lib/jenkins/builder/app.rb

@@ -4,6 +4,7 @@ require 'jenkins/builder/secret'
 require 'jenkins_api_client'
 require 'pastel'
 require 'tty-spinner'
+require 'time'
 
 module Jenkins
   module Builder
@@ -92,6 +93,24 @@ module Jenkins
         check_and_show_result(job_name, latest_build_no)
       end
 
+      def fetch_all_jobs
+        refresh_jobs_cache unless validate_jobs_cache
+        @config['jobs-cache']['jobs']
+      end
+
+      def refresh_jobs_cache
+        @config['jobs-cache'] = {
+          'expire' => (Time.now + 86400*30).strftime('%F %T'),
+          'jobs' => all_jobs
+        }
+        @config.save!
+      end
+
+      def validate_jobs_cache
+        @config['jobs-cache'] && !@config['jobs-cache'].empty? && \
+          Time.parse(@config['jobs-cache']['expire']) > Time.now
+      end
+
       def all_jobs
         @client.job.list_all
       end

data/lib/jenkins/builder/cli.rb

@@ -9,7 +9,7 @@ module Jenkins
       class << self
         def create_alias_commands(aliases)
           aliases.each do |name, command|
-            desc "#{name}", "alias for: #{command}"
+            desc "#{name}", "Alias for: `#{command}'"
             define_method name do |*args|
               self.class.start(Shellwords.split(command) + args)
             end
@@ -45,7 +45,7 @@ module Jenkins
       def build(*jobs)
         app = Jenkins::Builder::App.new(options)
         if jobs.empty?
-          jobs = fzf(app.all_jobs)
+          jobs = fzf(app.fetch_all_jobs)
           exit if jobs.empty?
           job = jobs.first
 
@@ -76,6 +76,11 @@ module Jenkins
         Jenkins::Builder::App.new.delete_alias(name)
       end
 
+      desc 'refresh-jobs-cache', 'Refresh cache of job names'
+      def refresh_jobs_cache
+        Jenkins::Builder::App.new.refresh_jobs_cache
+      end
+
       default_task :build
 
       no_commands do

data/lib/jenkins/builder/config.rb

@@ -17,6 +17,14 @@ module Jenkins
         end
       end
 
+      def [](k)
+        @config[k]
+      end
+
+      def []=(k, v)
+        @config[k] = v
+      end
+
       def username
         @config['username']
       end

data/lib/jenkins/builder/version.rb

@@ -1,5 +1,5 @@
 module Jenkins
   module Builder
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Liu Xiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor