caravan 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7cb3d50e30c03443ec81f6e32d799ba13fafc90
-  data.tar.gz: 668c9d16e7e21172a99d864070c6a8979086ec8c
+  metadata.gz: 04165e52055b23d22aefec5a138f1dd67fc1ee74
+  data.tar.gz: 4546e888f93eb980f88b3b1b43908c3069b0a0d1
 SHA512:
-  metadata.gz: 47f1ce0935393ea018d42d627d14e72e23521fbb579cfd009b2838802413ffb07b6d436e07c94dde3aaf15fdc0ce9efdbdf5609230cfcaf2e3c7a55f89139dbe
-  data.tar.gz: fd655b71e0e447e395d3f879682dc52a945e7f809883ffe5413769ff04e378701c467ef69275d20236cf9006eb766c4ad2f4e6f2873ec10ad7b9855e0c2e2371
+  metadata.gz: e3307a23f979a82803154973525a0aa6b31483685902180f847d102ccb7b1d7cbdabbdcfddec86bb5ec49cfbac50702ffb417b3221ec9e285d3e0c78b9647baf
+  data.tar.gz: a31c7fa8e58967a756ffc33bc10a32f8132b7cc4832fc2d8f145e35d431b5aaa47b2c30fac49c52d5469736678b12b846b72f7082d705de642214ee55a363a84

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at zhangwanlong@bytedance.com. All
+reported by contacting the project team at crispgm@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/README.md

@@ -9,6 +9,10 @@ Simple project files watcher and deployer.
 
 The scenario is when we are developing in your local workspace and the program only runs in specific runtime environment, we have to setup by ourself to make the program run and debug on runtime folders, or remote machines. Caravan is the automation tool designed for solving such kind of problems by watching the file changes, and deploy them automatically to its destination.
 
+![](/assets/civ-5-caravan.png)
+
+This is the caravan in Sid Meier's Civilization V, which the project name originally comes from.
+
 ## Installation
 
 ```
@@ -29,12 +33,26 @@ $ caravan --help
         --version                    Show version
 ```
 
-Example:
+## Examples
+
+Deploy to local directory:
 
 ```
 $ caravan -s /path/to/project/. -d /path/to/deploy -m shell
 ```
 
+Deploy to remote machines:
+
+```
+$ caravan -s /path/to/project/. -d user@remote_machines:/path/to/deploy -m rsync
+```
+
+Deploy only once:
+
+```
+$ caravan -s /path/to/project/. -d user@remote_machines:/path/to/deploy -m rsync --once
+```
+
 ## Configuration
 
 Generate default configuration:
@@ -55,6 +73,12 @@ exclude:
 - ".svn"
 ```
 
+You may also write `src` and `dst` to `caravan.yml`. Hence, deployment made even easier.
+
+```
+$ caravan
+```
+
 ## Plan
 
 - [x] Basic watching and deploying

data/caravan.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency "listen"
   spec.add_dependency "colorize"

data/exe/caravan

@@ -40,17 +40,20 @@ option_parser = OptionParser.new do |opts|
     options[:debug] = true
   end
 
+  opts.on_head("--init", "Init caravan.yml") do
+    Caravan.dump_default_conf
+    Caravan::Message.success("Generated #{Caravan::Config.default_conf_name}")
+    exit
+  end
+
   opts.on_tail("--version", "Show version") do
     puts Caravan::VERSION
     exit
   end
 end
 
-if ARGV.size == 1 && ARGV[0] == "init"
-  Caravan.dump_default_conf
-end
-
 option_parser.parse!(ARGV)
+
 merged_conf = Caravan::Config.merge(options, Caravan.process_conf(options[:src]))
 if merged_conf.key?("src") && merged_conf.key?("dst") && merged_conf.key?("deploy_mode")
   Caravan.start(merged_conf)

data/lib/caravan/version.rb

@@ -1,3 +1,3 @@
 module Caravan
-  VERSION = "0.5.2".freeze
+  VERSION = "0.6.0".freeze
 end

data/lib/caravan.rb

@@ -33,7 +33,7 @@ module Caravan
       Caravan::Message.success("Starting to watch #{src_path}...")
       deployer.after_create
       if merged_conf["once"]
-        deploy_at_once(deployer)
+        deploy_once(deployer)
         exit(0)
       end
       listener.start
@@ -48,7 +48,7 @@ module Caravan
       sleep_forever
     end
 
-    def deploy_at_once(deployer)
+    def deploy_once(deployer)
       deployer.before_deploy
       deployer.run
       deployer.after_deploy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caravan
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - David Zhang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2017-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -126,6 +126,7 @@ files:
 - README.md
 - Rakefile
 - _config.yml
+- assets/civ-5-caravan.png
 - caravan.gemspec
 - exe/caravan
 - lib/caravan.rb
@@ -150,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="