Merge branch 'appleboy:master' into master

appleboy · Oct 23, 2024 · 5b73b09 · 5b73b09
2 parents aed7361 + 8b84eae
commit 5b73b09
Show file tree

Hide file tree

Showing 8 changed files with 505 additions and 38 deletions.
diff --git a/.github/workflows/goreleaser.yml b/.github/workflows/goreleaser.yml
@@ -0,0 +1,33 @@
+name: Goreleaser
+
+on:
+  push:
+    tags:
+      - "*"
+
+permissions:
+  contents: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "^1"
+
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v6
+        with:
+          # either 'goreleaser' (default) or 'goreleaser-pro'
+          distribution: goreleaser
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -37,7 +37,10 @@ jobs:
           username: linuxserver.io
           password: password
           port: 2222
-          script: whoami
+          script: |
+            #!/usr/bin/env bash
+            set -e
+            whoami
 
   check-ssh-key:
     runs-on: ubuntu-latest
@@ -459,6 +462,16 @@ jobs:
             echo "$GITHUB_BASE_REF"
             echo "$GITHUB_REF"
 
+      - name: pass secret variable in shell
+        uses: ./
+        continue-on-error: true
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          key: ${{ env.PRIVATE_KEY }}
+          port: 2222
+          script: cd ${{ secrets.PORT }}
+
       - name: switch to root user
         uses: ./
         with:
@@ -491,6 +504,7 @@ jobs:
 
       - name: testing ipv6
         uses: ./
+        continue-on-error: true
         with:
           host: 2402:1f00:8000:800::2628
           username: ubuntu

diff --git a/.github/workflows/stable.yml b/.github/workflows/stable.yml
@@ -37,7 +37,10 @@ jobs:
           username: linuxserver.io
           password: password
           port: 2222
-          script: whoami
+          script: |
+            #!/usr/bin/env bash
+            set -e
+            whoami
 
   check-ssh-key:
     runs-on: ubuntu-latest

diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -0,0 +1,28 @@
+builds:
+  - # If true, skip the build.
+    # Useful for library projects.
+    # Default is false
+    skip: true
+
+changelog:
+  use: github
+  groups:
+    - title: Features
+      regexp: "^.*feat[(\\w)]*:+.*$"
+      order: 0
+    - title: "Bug fixes"
+      regexp: "^.*fix[(\\w)]*:+.*$"
+      order: 1
+    - title: "Enhancements"
+      regexp: "^.*chore[(\\w)]*:+.*$"
+      order: 2
+    - title: "Refactor"
+      regexp: "^.*refactor[(\\w)]*:+.*$"
+      order: 3
+    - title: "Build process updates"
+      regexp: ^.*?(build|ci)(\(.+\))??!?:.+$
+      order: 4
+    - title: "Documentation updates"
+      regexp: ^.*?docs?(\(.+\))??!?:.+$
+      order: 4
+    - title: Others
diff --git a/Dockerfile b/Dockerfile
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # 🚀 SSH for GitHub Actions
 
 [繁體中文](./README.zh-tw.md)
+[简体中文](./README.zh-cn.md)
 
 [GitHub Action](https://github.com/features/actions) for executing remote ssh commands.
 
@@ -17,7 +18,7 @@ This thing is built using [Golang](https://go.dev) and [drone-ssh](https://githu
 See [action.yml](./action.yml) for more detailed information.
 
 | Input Parameter           | Description                                                                              | Default Value |
-|---------------------------|------------------------------------------------------------------------------------------|---------------|
+| ------------------------- | ---------------------------------------------------------------------------------------- | ------------- |
 | host                      | SSH host address                                                                         |               |
 | port                      | SSH port number                                                                          | 22            |
 | passphrase                | SSH key passphrase                                                                       |               |
@@ -65,7 +66,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: executing remote ssh commands using password
-      uses: appleboy/ssh-action@v1.0.3
+      uses: appleboy/ssh-action@v1.1.0
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -81,9 +82,9 @@ output:
 whoami
 ======END======
 out: ***
-==============================================
-✅ Successfully executed commands to all host.
-==============================================
+===============================================
+✅ Successfully executed commands to all hosts.
+===============================================
 ```
 
 ### Setting up a SSH Key
@@ -181,7 +182,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.0.3
+  uses: appleboy/ssh-action@v1.1.0
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -194,7 +195,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v1.0.3
+  uses: appleboy/ssh-action@v1.1.0
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -207,7 +208,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.0.3
+  uses: appleboy/ssh-action@v1.1.0
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -224,7 +225,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
     with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -242,7 +243,7 @@ The default value of `port` is `22`.
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
     with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -257,7 +258,7 @@ The default value of `port` is `22`.
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
     with:
       host: "foo.com,bar.com"
 +     sync: true
@@ -273,7 +274,7 @@ The default value of `port` is `22`.
 
 ```diff
   - name: pass environment
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -298,7 +299,7 @@ _Inside `env` object, you need to pass every environment variable as a string, p
 
 ```diff
   - name: stop script if command error
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -351,7 +352,7 @@ Host FooServer
 
 ```diff
   - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -374,7 +375,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -400,7 +401,7 @@ Now you can adjust you config:
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.0.3
+    uses: appleboy/ssh-action@v1.1.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}