caravan 0.4.0.beta → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +16 -0
  3. data/README.md +30 -3
  4. data/lib/caravan/version.rb +1 -1
  5. metadata +5 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9e2ece0ac4cc244e44066c307bd42ecc2783ce27
4
- data.tar.gz: 4c43af6c423ad75213ee3e5d752753b2fa3e44dc
3
+ metadata.gz: 3056289441f97341f8e54ae2e285dbf7720e0d64
4
+ data.tar.gz: a65424290ac39ba323ba1608366cd206f2d68c32
5
5
  SHA512:
6
- metadata.gz: e0b3518e2c18b8b232a77e1662d5a809e3c308cd74f47e809071193f6c0c2718b665eed0343f3f09672f904348e03724ce5f0e189966b35ce1ceeda3811fd5c1
7
- data.tar.gz: f14925bf61bb43e1eee9edd1b3fd76cf4627fffd0a70310e889eac212d4abccd149112a9f348eda2fa8ec7c4de8b32af1c0fedc9780c9533f15ea58f5ad5c229
6
+ metadata.gz: b6879a9ce50b92bc462c22f02133416d892c962c9c3d1aed742c48adf28c57e8794aa169ec1b82a6e11266f7ef1e4dfa5200b6af09f50996ab3b7d0156d08dfe
7
+ data.tar.gz: 495b3c418566110b17ffecdfa8052a29e1c035a3949da42117e5feb2d7d7c3376b8d0bd426ca34bc2a952b191025e4447335c1474d033361a9088c534083ce7d
data/.codeclimate.yml ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ engines:
3
+ duplication:
4
+ enabled: true
5
+ config:
6
+ languages:
7
+ - ruby
8
+ fixme:
9
+ enabled: true
10
+ rubocop:
11
+ enabled: true
12
+ ratings:
13
+ paths:
14
+ - "**.rb"
15
+ exclude_paths:
16
+ - test/
data/README.md CHANGED
@@ -5,9 +5,9 @@
5
5
  [![Code Climate](https://codeclimate.com/github/crispgm/caravan/badges/gpa.svg)](https://codeclimate.com/github/crispgm/caravan)
6
6
  [![Test Coverage](https://codeclimate.com/github/crispgm/caravan/badges/coverage.svg)](https://codeclimate.com/github/crispgm/caravan/coverage)
7
7
 
8
- Simple watcher and deployer.
8
+ Simple project files watcher and deployer.
9
9
 
10
- The background is when you are developing in your local workspace and the program only runs in specific runtime. You have to setup by yourself to make the program run and debug on runtime folders or ,remote machines. Caravan is designed for solving such kind of problems by watching the file changes, and deploy them automatically to the its destination.
10
+ 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.
11
11
 
12
12
  ## Installation
13
13
 
@@ -19,6 +19,13 @@ $ gem install caravan
19
19
 
20
20
  ```
21
21
  $ caravan --help
22
+
23
+ -s, --source SOURCE_PATH Source path
24
+ -d, --dest DEST_PATH Destination path
25
+ -m, --mode DEPLOY_MODE Deploy mode
26
+ -i, --ignore IGNORE_FILES Ignore files
27
+ -b, --debug Debug mode
28
+ --version Show version
22
29
  ```
23
30
 
24
31
  Example:
@@ -27,13 +34,33 @@ Example:
27
34
  $ caravan -s /path/to/project/. -d /path/to/deploy -m shell
28
35
  ```
29
36
 
37
+ ## Configuration
38
+
39
+ Generate default configuration:
40
+
41
+ ```
42
+ $ cd /path/to/src
43
+ $ caravan init
44
+ ```
45
+
46
+ A `caravan.yml` will be generated as `/path/to/src/caravan.yml`. You may specify any options in command arguments except source path.
47
+
48
+ ```
49
+ debug: false
50
+ deploy_mode: rsync_local
51
+ incremental: true
52
+ exclude:
53
+ - ".git"
54
+ - ".svn"
55
+ ```
56
+
30
57
  ## Plan
31
58
 
32
59
  - [x] Basic watching and deploying
33
60
  - [x] Exclude watching unwanted files
34
61
  - [x] `caravan.yml` for project-specialized configuration
35
62
  - [ ] Watch and deploy only the changed file instead of the whole folder
36
- - [ ] Callback for deployment
63
+ - [ ] Callbacks for deployment
37
64
  - [ ] Multiple deployment configurations
38
65
 
39
66
  ## LICENSE
data/lib/caravan/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Caravan
2
- VERSION = "0.4.0.beta".freeze
2
+ VERSION = "0.4.0".freeze
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: caravan
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0.beta
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Zhang
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2017-10-07 00:00:00.000000000 Z
11
+ date: 2017-10-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: listen
@@ -116,6 +116,7 @@ executables:
116
116
  extensions: []
117
117
  extra_rdoc_files: []
118
118
  files:
119
+ - ".codeclimate.yml"
119
120
  - ".gitignore"
120
121
  - ".travis.yml"
121
122
  - CODE_OF_CONDUCT.md
@@ -151,9 +152,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
151
152
  version: '0'
152
153
  required_rubygems_version: !ruby/object:Gem::Requirement
153
154
  requirements:
154
- - - ">"
155
+ - - ">="
155
156
  - !ruby/object:Gem::Version
156
- version: 1.3.1
157
+ version: '0'
157
158
  requirements: []
158
159
  rubyforge_project:
159
160
  rubygems_version: 2.6.11