1

Signed-off-by: JackWhh <5264499+jack_whh@user.noreply.gitee.com>

.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Continuous Deploy 
+on: [push] 
+
+jobs:
+  deploy_job:
+    runs-on: ubuntu-latest  
+    name: sftp
+    steps:
+      - name: Checkout    
+        uses: actions/checkout@v2 
+
+      - name: deploy file to server
+        uses:  ./ # Uses an action in the root directory
+        with:  
+          username: 'wl'  
+          server: '${{ secrets.MAC_IP }}'
+          ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
+          local_path: './*' 
+          remote_path: '/Users/wl/Downloads/t/a'
+          sftpArgs: '-o ConnectTimeout=5'
+          # sftp_only: true
+          password: ${{secrets.SSH_PASSWORD}}
+          # delete_remote_files: true

Dockerfile

@@ -1,5 +1,8 @@
 # Container image that runs your code
-FROM alpine:3.10
+FROM alpine:3.13
+
+RUN echo "http://mirrors.aliyun.com/alpine/v3.13/main" > /etc/apk/repositories
+RUN echo "http://mirrors.aliyun.com/alpine/v3.13/community" >> /etc/apk/repositories
 
 # Copies your code file from your action repository to the filesystem path `/` of the container
 COPY entrypoint.sh /entrypoint.sh
@@ -12,4 +15,4 @@ RUN apk add --no-cache openssh
 
 
 # Code file to execute when the docker container starts up (`entrypoint.sh`)
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -2,56 +2,113 @@
 
 > Use this action to deploy your files to server using `SSH Private Key`
 
-> 使用此`action`部署你的项目到服务器上,`仅支持密钥对连接`
+> 使用此`action`部署你的项目到服务器上，中文介绍链接：[使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
+
+## 1. Inputs 
+
+| Name                   | Required             | Default | Description                                   |
+|------------------------|----------------------|---------|-----------------------------------------------|
+`username` | yes| | SSH username
+`server` | yes| | Remote host
+`port`| yes | 22 | Remote host port
+`ssh_private_key`| no| | You can copy private key from your `ssh_private_key` file, and save to`repo/settings/secrets`![](./resource/secret.jpg)
+`local_path`| yes| ./* | `local_path` of you project, if you want put single file:use path like `./myfile`, if you want put directory: use path like `./static/*`, it will put all files under `static` directory. Default to `./*`(will put all files in your repo).
+`remote_path`|yes|| Remote path
+`sftp_only`| no| | If your port only accepts the sftp protocol, set this option to `true`. However, please note that when this option is set to `true`, the remote folder will not be created automatically.
+<strike>args</strike> `sftpArgs` | no| | other args yor want to use of sftp, E.g.`-o ConnectTimeout=5`
+`delete_remote_files` | no | false | Set to `true` will delete remote path  folder and all files in it. 
+`password`| no| | SSH passsword，If a password is set, `ssh_private_key` is ignored. `for @v1.2.4 and greater`
+
+> **Warning**
+
+> Be careful when use `delete_remote_files`, This will delete remote path  folder and all files in it
+
+-----
+
+## 2.Action Examples
+
+```yaml
+on: [push]
+
+jobs:
+    deploy_job:
+    runs-on: ubuntu-latest
+    name: deploy
+    steps:
+        - name: Checkout
+        uses: actions/checkout@v2
+        - name: deploy file
+        uses: wlixcc/SFTP-Deploy-Action@v1.2.4
+        with:
+            username: 'root'
+            server: 'your server ip'
+            ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} 
+            local_path: './static/*'
+            remote_path: '/var/www/app'
+            sftpArgs: '-o ConnectTimeout=5'
+```
+
+```yaml
+on: [push]
+
+jobs:
+    deploy_job:
+    runs-on: ubuntu-latest
+    name: deploy
+    steps:
+        - name: Checkout
+        uses: actions/checkout@v2
+        - name: Deploy file
+        uses: wlixcc/SFTP-Deploy-Action@v1.2.4
+        with:
+            username: ${{ secrets.FTP_USERNAME }}
+            server: ${{ secrets.FTP_SERVER }}
+            port: ${{ secrets.FTP_PORT }}
+            local_path: './static/*'
+            remote_path: '/var/www/app'
+            sftp_only: true
+            password: ${{ secrets.FTP_PASSWORD }}
+```
+
+## 3. [Deploy React App Example](https://github.com/wlixcc/React-Deploy)
 
 
-## Inputs
+```yaml
+on: [push]
 
-### `username`
+jobs:
+    deploy_job:
+    runs-on: ubuntu-latest
+    name: build&deploy
+    steps:
+        # To use this repository's private action, you must check out the repository
+        - name: Checkout
+        uses: actions/checkout@v2
 
-> **Required** sftp username.
+        - name: Install Dependencies
+        run: yarn
+        - name: Build
+        run: yarn build
 
-### `server`
+        - name: deploy file to server
+        uses: wlixcc/SFTP-Deploy-Action@v1.2.4
+        with:
+            username: 'root'
+            server: '${{ secrets.SERVER_IP }}'
+            ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
+            local_path: './build/*'
+            remote_path: '/var/www/react-app'
+            sftpArgs: '-o ConnectTimeout=5'
+```
 
-> **Required** sftp server address.
+ ![](./resource/reactExample.jpg)
+ 
+ --------
 
-### `port`
+## 4.Invalid format? You need keep format
 
-> sftp srever port , default `22`.
+If you use the Ed25519 algorithm to generate an SSH key pair `ssh-keygen -t ed25519 -C "your_email@example.com"`,
+you need to note that the last line of the private key is a blank line. You need to keep this line when adding Repository secrets, otherwise it may lead to an `invalid format` error.
+ ![](./resource/keepformat.jpg)
 
-### `ssh_private_key`
-
-> **Required** you can copy private_key from your `ssh_private_key.pem file`, keep format, and save at`repo/settings/secrets`
-
-### `local_path`
-
-> **Required** `local_path` of you project, if you want put single file:use path like `./myfile`, if you want put directory: use path like `./static/*`, it will put all files under `static` directory. Default to `./*`(will put all files in your repo).
-
-### `remote_path`
-> **Required** remote_path
-
-### `args`
-> args of sftp cmd, E.g.`-o ConnectTimeout=5`
-
-
-## Example usage	
-
-
-	on: [push]
-
-	jobs:
-	  deploy_job:
-	    runs-on: ubuntu-latest
-	    name: deploy
-	    steps:
-	      - name: Checkout
-	        uses: actions/checkout@v2
-	      - name: deploy file
-	        uses: ./ # Uses an action in the root directory
-	        with:
-	          username: 'root'
-	          server: 'your server ip'
-	          private_key: ${{ secrets.SSH_PRIVATE_KEY }} 
-	          local_path: './static/*'
-	          remote_path: '/var/www/app' #make sure dir exist
-	          args: '-o ConnectTimeout=5'
+ 

action.yml

@@ -22,11 +22,20 @@ inputs:
   remote_path:
     description: 'files will copy to under remote_path'
     required: true
-    default: /
-
-  args:
+  sftp_only:
+    description: 'connection via sftp protocol only'
+    required: false
+    default: false
+  sftpArgs:
     description: 'sftp args'
     required: false
+  delete_remote_files:
+    description: 'This operation will delete all files in the remote path before upload. Please be careful set this to true'
+    required: false
+    default: false
+  password:
+    description: "SSH passsword，If a password is set, the secret key pair is ignored"
+    required: false
 
 
 runs:
@@ -39,7 +48,10 @@ runs:
     - ${{ inputs.ssh_private_key }}
     - ${{ inputs.local_path }}
     - ${{ inputs.remote_path }}
-    - ${{ inputs.args }}
+    - ${{ inputs.sftp_only }}
+    - ${{ inputs.sftpArgs }}
+    - ${{ inputs.delete_remote_files }}
+    - ${{ inputs.password }}
 
 branding:
   icon: 'upload-cloud'  

entrypoint.sh

@@ -3,22 +3,71 @@
 #set -e at the top of your script will make the script exit with an error whenever an error occurs (and is not explicitly handled)
 set -eu
 
-
-TEMP_SSH_PRIVATE_KEY_FILE='../private_key.pem'
+TEMP_SSH_PRIVATE_KEY_FILE='../private_wdhcr.pem'
 TEMP_SFTP_FILE='../sftp'
 
+# make sure remote path is not empty
+if [ -z "$6" ]; then
+   echo 'remote_path is empty'
+   exit 1
+fi
+
+# use password
+if [ -z != ${10} ]; then
+	echo 'use sshpass'
+	apk add sshpass
+
+	if test $9 == "true";then
+  		echo 'Start delete remote files'
+		sshpass -p ${10} ssh -o StrictHostKeyChecking=no -p $3 $1@$2 rm -rf $6
+	fi
+	if test $7 = "true"; then
+  		echo "Connection via sftp protocol only, skip the command to create a directory"
+	else
+ 	 	echo 'Create directory if needed'
+ 	 	sshpass -p ${10} ssh -o StrictHostKeyChecking=no -p $3 $1@$2 mkdir -p $6
+	fi
+
+	echo 'SFTP Start'
+	# create a temporary file containing sftp commands
+	printf "%s" "put -r $5 $6" >$TEMP_SFTP_FILE
+	#-o StrictHostKeyChecking=no avoid Host key verification failed.
+	SSHPASS=${10} sshpass -e sftp -oBatchMode=no -b $TEMP_SFTP_FILE -P $3 $8 -o StrictHostKeyChecking=no $1@$2
+
+	echo 'Deploy Success'
+
+    exit 0
+fi
+
 # keep string format
 printf "%s" "$4" >$TEMP_SSH_PRIVATE_KEY_FILE
+echo "-------"
+cat $TEMP_SSH_PRIVATE_KEY_FILE
+echo "======="
+echo "$4" >$TEMP_SSH_PRIVATE_KEY_FILE
+echo "-------"
+cat $TEMP_SSH_PRIVATE_KEY_FILE
 # avoid Permissions too open
 chmod 600 $TEMP_SSH_PRIVATE_KEY_FILE
 
-echo 'sftp start'
+# delete remote files if needed
+if test $9 == "true";then
+  echo 'Start delete remote files'
+  ssh -o StrictHostKeyChecking=no -p $3 -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2 rm -rf $6
+fi
 
+if test $7 = "true"; then
+  echo "Connection via sftp protocol only, skip the command to create a directory"
+else
+  echo 'Create directory if needed'
+  ssh -o StrictHostKeyChecking=no -p $3 -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2 mkdir -p $6
+fi
+
+echo 'SFTP Start'
 # create a temporary file containing sftp commands
 printf "%s" "put -r $5 $6" >$TEMP_SFTP_FILE
 #-o StrictHostKeyChecking=no avoid Host key verification failed.
-sftp -b $TEMP_SFTP_FILE -P $3 $7 -o StrictHostKeyChecking=no -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2
+sftp -b $TEMP_SFTP_FILE -P $3 $8 -o StrictHostKeyChecking=no -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2
 
-echo 'deploy success'
+echo 'Deploy Success'
 exit 0
-