git-runner 0.0.3 → 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. data/README.md +12 -7
  2. data/lib/git-runner/version.rb +1 -1
  3. metadata +2 -2
data/README.md CHANGED
@@ -1,17 +1,25 @@
1
- # GitRunner
1
+ # Git Runner
2
2
 
3
- GitRunner is a ruby framework to implement and run tasks after code has been pushed to a Git repository. It works by invoking `git-runner` through `hooks/post-update` in your remote Git repository.
3
+ git-runner is a ruby framework to implement and run tasks after code has been pushed to a Git repository. It works by invoking `git-runner` through `hooks/post-update` in your remote Git repository.
4
4
 
5
5
  [Demonstration Video, Using git-runner to perform automatic deploys](http://ascii.io/a/1349)
6
6
 
7
- Configuration for GitRunner is read from a pre-determined file within the repository (at this time, that file is config/deploy.rb but this will soon be configurable). Any instructions detected are then processed and ran.
7
+ Configuration for git-runner is read from a pre-determined file within the repository (at this time, that file is config/deploy.rb but this will soon be configurable). Any instructions detected are then processed and ran.
8
8
 
9
- Instructions are contained within `lib/git-runner/instructions`, though soon these will be extracted out to separate gems, leaving only the core instructions present. Currently the only *real* instruction that users will want to run is Deploy, which will checkout your code, run bundler and perform a cap deploy (with multistage support).
9
+ Instructions are contained within `lib/git-runner/instructions`. By default the instructions contained here and only used for support purposes, real functionality is abstracted into separate gems (at this time the only real instuction is deploy).
10
10
 
11
11
  ## Installation
12
12
 
13
13
  $ gem install git-runner
14
14
 
15
+ ## Install any additional modules (you'll want to do this to get any real functionality)
16
+
17
+ ### Deploy using Capistrano
18
+ [https://github.com/JamesBrooks/git-runner-deploy](https://github.com/JamesBrooks/git-runner-deploy)
19
+
20
+ gem install git-runner-deploy
21
+
22
+
15
23
  ## Usage
16
24
 
17
25
  Symlink `hooks/post-update` to `git-runner`, or if `post-update` is already in use modify it to run `git-runner` with the arguments supplied to the hook.
@@ -27,9 +35,6 @@ Configuration can be overwritten through a YAML file at either `/etc/git-runner.
27
35
 
28
36
  ## TODO
29
37
 
30
- * Extract our non-core instruction functionality into individual gems (e.g. the Deploy instruction)
31
- * Format README.md nicely
32
-
33
38
  ## Contributing
34
39
 
35
40
  1. Fork it
@@ -1,3 +1,3 @@
1
1
  module GitRunner
2
- VERSION = '0.0.3'
2
+ VERSION = '0.0.4'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: git-runner
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
4
+ version: 0.0.4
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2012-10-07 00:00:00.000000000 Z
12
+ date: 2012-10-09 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: session