pups 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055f645c7b240abd8d9d8206029043d1097611c8
-  data.tar.gz: 9a0c6803b35b3813058ed89c33f937a959dc9fcb
+  metadata.gz: cf30e6638af5d5e6618c872c48c916485a8d75f2
+  data.tar.gz: 28da8c64dc283ad29a17cfd02cdb92703c91e296
 SHA512:
-  metadata.gz: 2b64563d45db0ec09bb16465e09d81ca4ef39ac92dee8c1b6dd894a24ea4eda5ecc08e6890391e57e3653365f29a39fdcf17399ee383b7bcb9e7e5978ec44b52
-  data.tar.gz: 0069a7d13b2070240fc23b17befc9dc2a34d1a51c6e7573b575acf892d22251fbf1bd4c44a94820cc86c3d1dbdb5999e0b048fec6dc528a2ce44f0a81d62f9f7
+  metadata.gz: b6f37ce6dff5423dcae7b9e92816d6618693d6bb9fdd4e8af70e6e052f6ef31bc4c8397920b183ff985b1a4b0ee42150c812f0a4f5a48c922f9cc818b1ff885c
+  data.tar.gz: b3bdbd36b7a2cb327c27f7fc691296ded3a9e63044665939845b0165727259eee49a5664ea5de4674c68ca1f9024bdb16ce7b686397e51522b7eac1d83900a9e

data/README.md

@@ -1,6 +1,6 @@
 # pups
 
-Simple yaml based bootstrapper
+Simple YAML--based bootstrapper
 
 ## Installation
 
@@ -28,55 +28,70 @@ params:
   hello: hello world
 
 run:
-  exec: /bin/bash -c 'echo $hello >>> hello'
+  - exec: /bin/bash -c 'echo $hello >>> hello'
 ```
 
-Running: `pups somefile.yaml` will execute the shell script resulting in a file called "hello" with the "hello world" contents
+Running: `pups somefile.yaml` will execute the shell script resulting in a file called "hello" with the contents "hello world".
 
-### Features:
+### Features
 
-####Execution
+#### Environment Variables
+
+By default, pups automatically imports your environment variables and includes them as params.
+
+```
+# In bash
+export SECRET_KEY="secret value"
+
+# In somefile.yaml
+run:
+  - exec: echo "$SECRET_KEY"
+```
+
+Running the above code with pups will produce `secret value`.
+
+#### Execution
 
 Run multiple commands in one path:
 
 ```
 run:
-  exec:
-    cd: some/path
-    cmd:
-      - echo 1
-      - echo 2
+  - exec:
+      cd: some/path
+      cmd:
+        - echo 1
+        - echo 2
 ```
 
 Run commands in the background (for services etc)
 
 ```
 run:
-  exec:
-    cmd: /usr/bin/sshd
-    background: true
-``` 
+  - exec:
+      cmd: /usr/bin/sshd
+      background: true
+```
 
 Suppress exceptions on certain commands
 
 ```
 run:
-   exec:
-     cmd: /test
-     raise_on_faile: false
+  - exec:
+      cmd: /test
+      raise_on_fail: false
 ```
 
-####Replacements:
+#### Replacements:
 
 ```
 run:
-  replace:
-    filename: "/etc/redis/redis.conf"
-    from: /^pidfile.*$/
-    to: ""
+  - replace:
+      filename: "/etc/redis/redis.conf"
+      from: /^pidfile.*$/
+      to: ""
 ```
 
-Will substitued the regex with blank, removing the pidfile line
+Will substitute the regex with blank, removing the pidfile line
 
 ```
 run:
@@ -88,9 +103,34 @@ run:
       }"
 ```
 
-Multiline replace using regex
+Additional params:
 
-####Merge yaml files:
+Global replace (as opposed to first match)
+```
+global: true
+```
+
+#### Hooks
+
+Execute commands before and after a specific command by defining a hook.
+
+```
+run
+  - exec:
+      hook: hello
+      cmd: echo 'Hello'
+
+hooks:
+  before_hello:
+    - exec:
+        cmd: echo 'Starting...'
+
+  after_hello:
+    - exec:
+        cmd: echo 'World'
+```
+
+#### Merge yaml files
 
 ```
 home: /var/www/my_app
@@ -105,9 +145,11 @@ run:
 
 ```
 
-Will merge the yaml file with the inline contents
+Will merge the yaml file with the inline contents.
+
+#### A common environment
 
-####A common environment
+This is implemented in discourse_docker's launcher, not in pups - therefore it does not work in standalone pups.
 
 ```
 env:

data/lib/pups/version.rb

@@ -1,3 +1,3 @@
 module Pups
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pups
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Process orchestrator