docs: add stop script if command error

.github/workflows/ci.yml

@@ -35,15 +35,15 @@ jobs:
           whoami
           ls -al
 
-    - name: stop script if command error
+    # - name: stop script if command error
-      uses: appleboy/ssh-action@master
+    #   uses: appleboy/ssh-action@master
-      with:
+    #   with:
-        host: ${{ secrets.HOST }}
+    #     host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
+    #     username: ${{ secrets.USERNAME }}
-        key: ${{ secrets.KEY }}
+    #     key: ${{ secrets.KEY }}
-        port: ${{ secrets.PORT }}
+    #     port: ${{ secrets.PORT }}
-        script_stop: true
+    #     script_stop: true
-        script: "mkdir abc/def,ls -al"
+    #     script: "mkdir abc/def,ls -al"
 
     - name: pass environment
       uses: appleboy/ssh-action@master

README.md

@@ -126,3 +126,17 @@ Pass environment variable to shell script
       echo "I am $FOO"
       echo "I am $BAR"
 ```
+
+Stop script after first failure. ex: missing `abc` folder
+
+```yaml
+- name: stop script if command error
+  uses: appleboy/ssh-action@master
+  with:
+    host: ${{ secrets.HOST }}
+    username: ${{ secrets.USERNAME }}
+    key: ${{ secrets.KEY }}
+    port: ${{ secrets.PORT }}
+    script_stop: true
+    script: "mkdir abc/def,ls -al"
+```