pm.sh - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

doc/application-definition.md

@@ -6,18 +6,10 @@ Application definition files
 
-## Custom
 
-Put a `app.sh` or `app.bash` in your projectdir:
-
-    #!/bin/bash
-    export MY_ENV_VAR=foobar
-    [[ -f app.bash.live ]] && source app.bash.live
-    npm start
-
 ## Nodejs (package.json)
 
-Put a `package.json` in your projectdir:
+Put a `package.json` in your projectdir (foo/app1 etc):
 
     {
       "scripts":{
-        "start": "{ source env.sh; source env.production.sh } 2>/dev/null ; source env.sh && node app.js"
+        "start": "node app.js"
       }
@@ -36,1 +28,19 @@ }
     export PASSWORD=XXXXXXXX
+
+> `env.sh` and `env.production.sh` are automatically sourced if present
+
+Then add the projectdir
+
+    $ pm add foo/app1
+    $ pm inspect app1
+    $ pm start app1
+
+## Custom
+
+[TODO: implementation]
+Put a `app.sh` or `app.bash` in your projectdir:
+
+    #!/bin/bash
+    export MY_ENV_VAR=foobar
+    [[ -f app.bash.live ]] && source app.bash.live
+    npm start

package.json

 {
   "name": "pm.sh",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "pm2 without the fat in 1 shellscript, unix processmanagement using simply 'ps' and 'flock' and a teaspoon of shellscript & extra features",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -5,3 +5,3 @@ <img src="doc/logo.png" width="120"/>
 
-Philosophy: #unixy, #lightweight, #nodependencies, #commandline, #minimal
+Philosophy: #unixy, #lightweight, #nodependencies, #commandline, #minimal, #github, #bitbucket
 Basically it's pm2 without the fat, and `ps`+`flock` wrapped in bash.
@@ -23,11 +23,11 @@
       pm startall                                  start all applications                                           
-      pm stopall                                   stop all applications                                           
-      pm tail <appname>                            monitor logs                                                        
+      pm stopall                                   stop all applications                                            
+      pm tail <appname>                            monitor logs                                                     
       pm inspect <appname>                         show all related files, startcmds, env-vars                      
+      pm debug <appname>                           start application in foreground (for testing purposes)           
                                                                                                                     
-      pm config ga <appname>                       configure google analytics (opens default editor)                
-      pm config webhook <appname>                  add POST webhook (opens default editor)                          
-                                                                                                                
+      type 'pm -h' to see all options: receiving github/bitbucket webhooks, pushing to google analytics etc
                                                    ┌─────────────────────────────────────────────────┐              
                                                    │ docs: https://github.com/coderofsalvation/pm.sh │              
+                                                                                                                
 
@@ -64,3 +64,3 @@ ## Demo
 * nodejs `package.json` support
-* events can be pushed to custom webhooks (per application-config)
+* inbound / outbound custom webhooks (per application-config)
 * events can be pushed to google analytics (per application-config)
@@ -73,2 +73,17 @@ * [TODO] app.sh support (native)
 
+## Git / Bitbucket / Anywhere push webhooks
+
+Automatically update your running application ('app1' for example) when you push to Github/Bitbucket.
+
+    $ pm config pmserver && pm start pmserver 
+    
+* Now you can enter __ttp://yourdomain.com:8080/{yourappname}/pull__ as Github/BB webhook value (only push!)
+
+Or call from another service:
+
+    $ curl -X POST -H 'Content-Type: application/json' http://localhost:8080/pull/app1
+    $ curl -X POST -H 'Content-Type: application/json' http://localhost:8080/start/app1
+    $ curl -X POST -H 'Content-Type: application/json' http://localhost:8080/stop/app1
+    $ curl -X POST -H 'Content-Type: application/json' http://localhost:8080/restart/app1
+
 ## Why
@@ -75,0 +90,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

77792

increased by20.74%

Number of package files

32

increased by10.34%

Lines of code

288

increased byInfinity%

Number of lines in readme file

91

increased by19.74%

No dependency changes