docs: improve documentation and testing configurations

- Add example for using environment variables with `scp-action` in README.md

Signed-off-by: appleboy <appleboy.tw@gmail.com>

.github/workflows/ci.yml

@@ -1,13 +1,12 @@
 name: scp files
 on: [push]
 jobs:
-
   testing:
     name: test scp action
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-      uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: copy file via ssh password
         uses: ./
@@ -63,43 +62,21 @@ jobs:
           target: "test"
           use_insecure_cipher: true
 
-    - name: correct key but wrong password
-      uses: appleboy/scp-action@7af00892de6f8397c5c3393cfb3b32ae7f91b94b
-      with:
-        host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
-        key: ${{ secrets.KEY }}
-        password: abcdefg
-        port: ${{ secrets.PORT }}
-        source: "tests/a.txt,tests/b.txt"
-        target: "test"
-
-    - name: correct password but wrong key
-      uses: appleboy/scp-action@7af00892de6f8397c5c3393cfb3b32ae7f91b94b
-      with:
-        host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
-        key: abcdefg
-        password: ${{ secrets.PASSWORD }}
-        port: ${{ secrets.PORT }}
-        source: "tests/a.txt,tests/b.txt"
-        target: "test"
-
   deploy:
-    name: deploy artifact
+    name: test deploy artifact
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-      uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - run: echo hello > world.txt
 
-    - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: my-artifact
           path: world.txt
 
-    - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: my-artifact
           path: distfiles
@@ -119,11 +96,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-      uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Get changed files
         id: changed-files
-      uses: tj-actions/changed-files@v35
+        uses: tj-actions/changed-files@v45
         with:
           since_last_remote_commit: true
           separator: ","
@@ -137,3 +114,37 @@ jobs:
           port: ${{ secrets.PORT }}
           source: ${{ steps.changed-files.outputs.all_changed_files }}
           target: test
+
+  target:
+    name: test target folder
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: copy file to server
+        uses: ./
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.KEY }}
+          port: ${{ secrets.PORT }}
+          source: tests/a.txt,tests/b.txt
+          target: foobar foobar   1234
+
+  multipleHost:
+    name: test Multiple Host
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: copy file to server
+        uses: ./
+        with:
+          host: ${{ secrets.HOST }}:${{ secrets.PORT }},${{ secrets.HOST }}:${{ secrets.PORT }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.KEY }}
+          port: 1024
+          source: tests/a.txt,tests/b.txt
+          target: foobar

.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 }}

.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

Dockerfile

@@ -1,5 +1,5 @@
-FROM ghcr.io/appleboy/drone-scp:1.6.7
+FROM ghcr.io/appleboy/drone-scp:1.6.14
 
-COPY entrypoint.sh /entrypoint.sh
+COPY entrypoint.sh /bin/entrypoint.sh
-RUN chmod +x /entrypoint.sh
+
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["/bin/entrypoint.sh"]

README.md

@@ -14,59 +14,60 @@ Copy files and artifacts via SSH:
 name: scp files
 on: [push]
 jobs:
-
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+      - uses: actions/checkout@v4
       - name: copy file via ssh password
-      uses: appleboy/scp-action@master
+        uses: appleboy/scp-action@v0.1.7
         with:
           host: ${{ secrets.HOST }}
           username: ${{ secrets.USERNAME }}
           password: ${{ secrets.PASSWORD }}
           port: ${{ secrets.PORT }}
           source: "tests/a.txt,tests/b.txt"
-        target: "test"
+          target: your_server_target_folder_path
 ```
 
 ## Input variables
 
 See the [action.yml](./action.yml) file for more detail information.
 
-* host - scp remote host
+- host - scp remote host
-* port - scp remote port, default is `22`
+- port - scp remote port, default is `22`
-* username - scp username
+- username - scp username
-* password - scp password
+- password - scp password
-* passphrase - the passphrase is usually to encrypt the private key
+- passphrase - the passphrase is usually to encrypt the private key
-* fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
+- protocol - The IP protocol to use. Valid values are `tcp`. `tcp4` or `tcp6`. Default to `tcp`.
-* timeout - timeout for ssh to remote host, default is `30s`
+- fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
-* command_timeout - timeout for scp command, default is `10m`
+- timeout - timeout for ssh to remote host, default is `30s`
-* key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
+- command_timeout - timeout for scp command, default is `10m`
-* key_path - path of ssh private key
+- key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
-* target - target path on the server, must be a directory (**required**)
+- key_path - path of ssh private key
-* source - scp file list (**required**)
+- target - target path on the server, must be a directory (**required**)
-* rm - remove target folder before upload data, default is `false`
+- source - scp file list (**required**)
-* strip_components - remove the specified number of leading path elements.
+- rm - remove target folder before upload data, default is `false`
-* overwrite - use `--overwrite` flag with tar, overwrite existing files when extracting
+- strip_components - remove the specified number of leading path elements.
-* tar_tmp_path - temporary path for tar file on the dest host
+- overwrite - use `--overwrite` flag with tar, overwrite existing files when extracting
-* tar_exec - path to tar executable on the dest host. default is `tar`
+- tar_tmp_path - temporary path for tar file on the dest host
-* tar_dereference - use `--dereference` flag with tar, follow symlinks; archive and dump the files they point to
+- tar_exec - path to tar executable on the dest host. default is `tar`
-* use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
+- tar_dereference - use `--dereference` flag with tar, follow symlinks; archive and dump the files they point to
+- use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
 
 SSH Proxy Setting:
 
-* proxy_host - proxy host
+- proxy_host - proxy host
-* proxy_port - proxy port, default is `22`
+- proxy_port - proxy port, default is `22`
-* proxy_username - proxy username
+- proxy_username - proxy username
-* proxy_password - proxy password
+- proxy_password - proxy password
-* proxy_passphrase - the passphrase is usually to encrypt the private key
+- proxy_protocol - The IP protocol to use. Valid values are `tcp`. `tcp4` or `tcp6`. Default to `tcp`.
-* proxy_timeout - timeout for ssh to proxy host, default is `30s`
+- proxy_passphrase - the passphrase is usually to encrypt the private key
-* proxy_key - content of ssh proxy private key.
+- proxy_timeout - timeout for ssh to proxy host, default is `30s`
-* proxy_key_path - path of ssh proxy private key
+- proxy_key - content of ssh proxy private key.
-* proxy_fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
+- proxy_key_path - path of ssh proxy private key
-* proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
+- proxy_fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
+- proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
 
 ## Setting up a SSH Key
 
@@ -106,9 +107,9 @@ See the detail information about [SSH login without password](http://www.linuxpr
 
 **A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
 
-* Put the public key in `.ssh/authorized_keys2`
+- Put the public key in `.ssh/authorized_keys2`
-* Change the permissions of `.ssh` to 700
+- Change the permissions of `.ssh` to 700
-* Change the permissions of `.ssh/authorized_keys2` to 640
+- Change the permissions of `.ssh/authorized_keys2` to 640
 
 ### If you are using OpenSSH
 
@@ -137,48 +138,62 @@ Copy file via a SSH password:
 
 ```yaml
 - name: copy file via ssh password
-  uses: appleboy/scp-action@master
+  uses: appleboy/scp-action@v0.1.7
   with:
     host: example.com
     username: foo
     password: bar
     port: 22
     source: "tests/a.txt,tests/b.txt"
-    target: "test"
+    target: your_server_target_folder_path
+```
+
+Using the environment variables
+
+```yaml
+- name: copy file via ssh password
+  uses: appleboy/scp-action@v0.1.7
+  with:
+    host: ${{ env.HOST }}
+    username: ${{ env.USERNAME }}
+    password: ${{ secrets.PASSWORD }}
+    port: ${{ env.PORT }}
+    source: "tests/a.txt,tests/b.txt"
+    target: ${{ env.TARGET_PATH }}
 ```
 
 Copy file via a SSH key:
 
 ```yaml
 - name: copy file via ssh key
-  uses: appleboy/scp-action@master
+  uses: appleboy/scp-action@v0.1.7
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
     port: ${{ secrets.PORT }}
     key: ${{ secrets.KEY }}
     source: "tests/a.txt,tests/b.txt"
-    target: "test"
+    target: your_server_target_folder_path
 ```
 
 Example configuration for ignore list:
 
 ```yaml
 - name: copy file via ssh key
-  uses: appleboy/scp-action@master
+  uses: appleboy/scp-action@v0.1.7
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
     port: ${{ secrets.PORT }}
     key: ${{ secrets.KEY }}
     source: "tests/*.txt,!tests/a.txt"
-    target: "test"
+    target: your_server_target_folder_path
 ```
 
 Example configuration for multiple servers:
 
 ```diff
-  uses: appleboy/scp-action@master
+  uses: appleboy/scp-action@v0.1.7
   with:
 -   host: "example.com"
 +   host: "foo.com,bar.com"
@@ -186,13 +201,13 @@ Example configuration for multiple servers:
     password: bar
     port: 22
     source: "tests/a.txt,tests/b.txt"
-    target: "test"
+    target: your_server_target_folder_path
 ```
 
 Example configuration for exclude custom files:
 
 ```yaml
-  uses: appleboy/scp-action@master
+  uses: appleboy/scp-action@v0.1.7
   with:
     host: "example.com"
     username: foo
@@ -200,7 +215,7 @@ Example configuration for exclude custom files:
     port: 22
 -   source: "tests/*.txt"
 +   source: "tests/*.txt,!tests/a.txt,!tests/b.txt"
-    target: "test"
+    target: your_server_target_folder_path
 ```
 
 Upload artifact files to remote server:
@@ -211,74 +226,46 @@ Upload artifact files to remote server:
   runs-on: ubuntu-latest
   steps:
     - name: checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - run: echo hello > world.txt
 
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
         name: my-artifact
         path: world.txt
 
-    - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v4
       with:
         name: my-artifact
         path: distfiles
 
     - name: copy file to server
-      uses: appleboy/scp-action@master
+      uses: appleboy/scp-action@v0.1.7
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
         key: ${{ secrets.KEY }}
         port: ${{ secrets.PORT }}
         source: distfiles/*
-        target: test
+        target: your_server_target_folder_path
 ```
 
 Remove the specified number of leading path elements:
 
 ```yaml
 - name: remove the specified number of leading path elements
-  uses: appleboy/scp-action@master
+  uses: appleboy/scp-action@v0.1.7
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
     key: ${{ secrets.KEY }}
     port: ${{ secrets.PORT }}
     source: "tests/a.txt,tests/b.txt"
-    target: "foobar"
+    target: your_server_target_folder_path
     strip_components: 1
 ```
 
-Only copy files that are newer than the corresponding destination files:
-
-```yaml
-  changes:
-    name: test changed-files
-    runs-on: ubuntu-latest
-    steps:
-    - name: checkout
-      uses: actions/checkout@v3
-
-    - name: Get changed files
-      id: changed-files
-      uses: tj-actions/changed-files@v35
-      with:
-        since_last_remote_commit: true
-        separator: ","
-
-    - name: copy file to server
-      uses: appleboy/scp-action@master
-      with:
-        host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
-        key: ${{ secrets.KEY }}
-        port: ${{ secrets.PORT }}
-        source: ${{ steps.changed-files.outputs.all_changed_files }}
-        target: test
-```
-
 Old target structure:
 
 ```sh
@@ -296,11 +283,39 @@ foobar
   └── b.txt
 ```
 
+Only copy files that are newer than the corresponding destination files:
+
+```yaml
+changes:
+  name: test changed-files
+  runs-on: ubuntu-latest
+  steps:
+    - name: checkout
+      uses: actions/checkout@v4
+
+    - name: Get changed files
+      id: changed-files
+      uses: tj-actions/changed-files@v35
+      with:
+        since_last_remote_commit: true
+        separator: ","
+
+    - name: copy file to server
+      uses: appleboy/scp-action@v0.1.7
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        source: ${{ steps.changed-files.outputs.all_changed_files }}
+        target: your_server_target_folder_path
+```
+
 Protecting a Private Key. The purpose of the passphrase is usually to encrypt the private key. This makes the key file by itself useless to an attacker. It is not uncommon for files to leak from backups or decommissioned hardware, and hackers commonly exfiltrate files from compromised systems.
 
 ```diff
   - name: ssh key with passphrase
-    uses: appleboy/scp-action@master
+    uses: appleboy/scp-action@v0.1.7
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -308,5 +323,36 @@ Protecting a Private Key. The purpose of the passphrase is usually to encrypt th
 +     passphrase: ${{ secrets.PASSPHRASE }}
       port: ${{ secrets.PORT }}
       source: "tests/a.txt,tests/b.txt"
-      target: "test"
+      target: your_server_target_folder_path
+```
+
+When copying files from a Linux runner to a Windows server, you should:
+
+1. Download git for Windows
+2. Change the default OpenSSH shell to git bach with the following powershell command.
+3. Set `tar_dereference` and `rm` variable to `true` in the YAML file
+4. Avoid putting the `port` value through a variable
+5. Convert the target path to a Unix path: `/c/path/to/target/`
+
+Change the default OpenSSH shell to git bach with the following powershell command.
+
+```powershell
+New-ItemProperty -Path "HKLM:\SOFTWARE\OpenSSH" -Name DefaultShell -Value "$env:Programfiles\Git\bin\bash.exe" -PropertyType String -Force
+```
+
+Convert the target path to a Unix path: `/c/path/to/target/`
+
+```diff
+  - name: Copy to Windows
+      uses: appleboy/scp-action@v0.1.7
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.SSH_PRIVATE_KEY }}
+        port: 22
+        source: 'your_source_path'
+-       target: 'C:\path\to\target'
++       target: '/c/path/to/target/'
++       tar_dereference: true
++       rm: true
 ```

action.yml

@@ -1,84 +1,80 @@
-name: 'SCP Command to Transfer Files'
+name: "SCP Command to Transfer Files"
-description: 'How to Use SCP Command to Transfer Files/Folders in Linux'
+description: "How to Use SCP Command to Transfer Files/Folders in Linux"
-author: 'Bo-Yi Wu'
+author: "Bo-Yi Wu"
 inputs:
   host:
-    description: 'scp remote host'
+    description: "scp remote host"
   port:
-    description: 'scp remote port'
+    description: "scp remote port"
-    default: 22
+    default: "22"
   username:
-    description: 'scp username'
+    description: "scp username"
   password:
-    description: 'scp password'
+    description: "scp password"
+  protocol:
+    description: "The IP protocol to use. Valid values are 'tcp'. 'tcp4' or 'tcp6'. Default to tcp."
+    default: "tcp"
   timeout:
-    description: 'timeout for ssh to remote host'
+    description: "timeout for ssh to remote host"
     default: "30s"
   command_timeout:
-    description: 'timeout for scp command'
+    description: "timeout for scp command"
     default: "10m"
   key:
-    description: 'content of ssh private key. ex raw content of ~/.ssh/id_rsa'
+    description: "content of ssh private key. ex raw content of ~/.ssh/id_rsa"
   key_path:
-    description: 'path of ssh private key'
+    description: "path of ssh private key"
   passphrase:
-    description: 'ssh key passphrase'
+    description: "ssh key passphrase"
   fingerprint:
-    description: 'fingerprint SHA256 of the host public key, default is to skip verification'
+    description: "fingerprint SHA256 of the host public key, default is to skip verification"
   use_insecure_cipher:
-    description: 'include more ciphers with use_insecure_cipher'
+    description: "include more ciphers with use_insecure_cipher"
-    default: false
   target:
-    description: 'target path on the server, must be a directory path.'
+    description: "target path on the server, must be a directory path."
   source:
-    description: 'scp file list'
+    description: "scp file list"
   rm:
-    description: 'remove target folder before upload data'
+    description: "remove target folder before upload data"
-    default: false
   debug:
-    description: 'enable debug message'
+    description: "enable debug message"
-    default: false
   strip_components:
-    description: 'remove the specified number of leading path elements'
+    description: "remove the specified number of leading path elements"
-    default: 0
   overwrite:
-    description: 'use --overwrite flag with tar'
+    description: "use --overwrite flag with tar"
-    default: false
   tar_dereference:
-    description: 'use --dereference flag with tar'
+    description: "use --dereference flag with tar"
-    default: false
   tar_tmp_path:
-    description: 'temporary path for tar file on the dest host'
+    description: "temporary path for tar file on the dest host"
   tar_exec:
-    description: 'temporary path for tar file on the dest host'
+    description: "temporary path for tar file on the dest host"
-    default: 'tar'
+    default: "tar"
   proxy_host:
-    description: 'ssh proxy remote host'
+    description: "ssh proxy remote host"
   proxy_port:
-    description: 'ssh proxy remote port'
+    description: "ssh proxy remote port"
-    default: 22
+    default: "22"
   proxy_username:
-    description: 'ssh proxy username'
+    description: "ssh proxy username"
   proxy_password:
-    description: 'ssh proxy password'
+    description: "ssh proxy password"
   proxy_passphrase:
-    description: 'ssh proxy key passphrase'
+    description: "ssh proxy key passphrase"
   proxy_timeout:
-    description: 'timeout for ssh to proxy host'
+    description: "timeout for ssh to proxy host"
     default: "30s"
   proxy_key:
-    description: 'content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa'
+    description: "content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa"
   proxy_key_path:
-    description: 'path of ssh proxy private key'
+    description: "path of ssh proxy private key"
   proxy_fingerprint:
-    description: 'fingerprint SHA256 of the host public key, default is to skip verification'
+    description: "fingerprint SHA256 of the host public key, default is to skip verification"
   proxy_use_insecure_cipher:
-    description: 'include more ciphers with use_insecure_cipher'
+    description: "include more ciphers with use_insecure_cipher"
-    default: false
 runs:
-  using: 'docker'
+  using: "docker"
-  image: 'Dockerfile'
+  image: "Dockerfile"
 
 branding:
-  icon: 'copy'
+  icon: "copy"
-  color: 'gray-dark'
+  color: "gray-dark"