chore: standardize formatting and update dependencies in workflows

- Change the title format in the bug report template from single quotes to double quotes - Update `appleboy/ssh-action` version from `v1.2.0` to `v1.2.1` in multiple workflow files - Remove unnecessary blank lines in the bug report template Signed-off-by: Bo-Yi Wu <[email protected]>
appleboy · Feb 19, 2025 · 8faa842 · 8faa842
1 parent 49751ff
commit 8faa842
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 63 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
 assignees: appleboy
-
 ---
 
 ## Describe the bug
@@ -19,19 +18,18 @@ Please post your Yaml configuration file along with the output results.
 name: remote ssh command
 on: [push]
 jobs:
-
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
-    - name: executing remote ssh commands using password
-      uses: appleboy/[email protected].0
-      with:
-        host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
-        password: ${{ secrets.PASSWORD }}
-        port: ${{ secrets.PORT }}
-        script: whoami
+      - name: executing remote ssh commands using password
+        uses: appleboy/[email protected].1
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          port: ${{ secrets.PORT }}
+          script: whoami
 ```
 
 ## Related environment

diff --git a/.github/workflows/stable.yml b/.github/workflows/stable.yml
@@ -31,7 +31,7 @@ jobs:
           sleep 2
 
       - name: ssh by username and password
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -43,7 +43,7 @@ jobs:
             whoami
 
       - name: ssh commands from a file
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -95,7 +95,7 @@ jobs:
           sleep 2
 
       - name: ssh by private key
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -104,7 +104,7 @@ jobs:
           script: whoami
 
       - name: wrong password but correct key
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -114,7 +114,7 @@ jobs:
           script: whoami
 
       - name: correct password but wrong key
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -167,7 +167,7 @@ jobs:
           sleep 2
 
       - name: ssh key passphrase
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -179,7 +179,7 @@ jobs:
             ls -al
 
       - name: missing ssh key passphrase
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         continue-on-error: true
         with:
           host: ${{ env.REMOTE_HOST }}
@@ -192,7 +192,7 @@ jobs:
 
       # https://github.com/appleboy/ssh-action/issues/75#issuecomment-668314271
       - name: Multiline SSH commands interpreted as single lines
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -269,7 +269,7 @@ jobs:
 
       # https://github.com/appleboy/ssh-action/issues/85
       - name: Deployment to multiple hosts with different ports
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: "${{ env.REMOTE_HOST_01 }}:2222,${{ env.REMOTE_HOST_02 }}:2222"
           username: linuxserver.io
@@ -322,7 +322,7 @@ jobs:
           sleep 2
 
       - name: testing id_ed25519 key
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -375,7 +375,7 @@ jobs:
           sleep 2
 
       - name: testing id_ed25519 key
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io
@@ -386,7 +386,7 @@ jobs:
             ls -al
 
       - name: pass environment
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         env:
           FOO: "BAR"
         with:
@@ -400,7 +400,7 @@ jobs:
             echo "I am $BAR, thanks"
 
       - name: pass multiple environment
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         env:
           FOO: "BAR"
           BAR: "FOO"
@@ -419,7 +419,7 @@ jobs:
             echo "port: $PORT"
 
       - name: custom envs format
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         env:
           FOO: "BAR"
           AAA: "BBB"
@@ -437,7 +437,7 @@ jobs:
             echo "I am $TEST_AAA, thanks"
 
       - name: pass all ENV variables to script
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         env:
           INPUT_FOO: "BAR"
           INPUT_AAA: "BBB"
@@ -454,7 +454,7 @@ jobs:
             echo "$GITHUB_REF"
 
       - name: switch to root user
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ env.REMOTE_HOST }}
           username: linuxserver.io

diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: executing remote ssh commands using password
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ secrets.HOST }}
           username: linuxserver.io
@@ -179,7 +179,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"
 
 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -192,7 +192,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"
 
 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -205,7 +205,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"
 
 ```yaml
 - name: multiple command
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -222,7 +222,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"
 
 ```yaml
 - name: file commands
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -235,7 +235,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"
 
 ```diff
   - name: multiple host
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -253,7 +253,7 @@ The default value of `port` is `22`.
 
 ```diff
   - name: multiple host
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -268,7 +268,7 @@ The default value of `port` is `22`.
 
 ```diff
   - name: multiple host
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: "foo.com,bar.com"
 +     sync: true
@@ -284,7 +284,7 @@ The default value of `port` is `22`.
 
 ```diff
   - name: pass environment
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -331,7 +331,7 @@ Host FooServer
 
 ```diff
   - name: ssh proxy command
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -354,7 +354,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -380,7 +380,7 @@ Now you can adjust you config:
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}

diff --git a/README.zh-cn.md b/README.zh-cn.md
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: executing remote ssh commands using password
-        uses: appleboy/[email protected].0
+        uses: appleboy/[email protected].1
         with:
           host: ${{ secrets.HOST }}
           username: ${{ secrets.USERNAME }}
@@ -162,7 +162,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -175,7 +175,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -188,7 +188,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```yaml
 - name: multiple command
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -205,7 +205,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```diff
   - name: multiple host
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
 -     host: ”foo.com“
 +     host: ”foo.com,bar.com“
@@ -221,7 +221,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```yaml
 - name: file commands
-  uses: appleboy/[email protected].0
+  uses: appleboy/[email protected].1
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -234,7 +234,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```diff
   - name: multiple host
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
 -     host: ”foo.com“
 +     host: ”foo.com:1234,bar.com:5678“
@@ -249,7 +249,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```diff
   - name: multiple host
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: ”foo.com,bar.com“
 +     sync: true
@@ -265,7 +265,7 @@ ssh-keygen -t ed25519 -a 200 -C ”[email protected]“
 
 ```diff
   - name: pass environment
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
 +   env:
 +     FOO: ”BAR“
 +     BAR: ”FOO“
@@ -312,7 +312,7 @@ Host FooServer
 
 ```diff
   - name: ssh proxy command
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -333,7 +333,7 @@ Host FooServer
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -359,7 +359,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ’
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/[email protected].0
+    uses: appleboy/[email protected].1
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}