Merge pull request #26 from leoppro/master

Add an option named `sftp_only` to connect via sftp only

README.md

@@ -4,37 +4,47 @@
 
 > 使用此`action`部署你的项目到服务器上,`仅支持密钥对连接`
 
+> [使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
+
 
 ## Inputs
 
 ### `username`
 
-> **Required** sftp username.
+**Required** sftp username.
 
 ### `server`
 
-> **Required** sftp server address.
+**Required** sftp server address.
 
 ### `port`
 
-> sftp srever port , default `22`.
+sftp srever port , default `22`
 
 ### `ssh_private_key`
 
-> **Required** you can copy private_key from your `ssh_private_key.pem file`, keep format, and save at`repo/settings/secrets`
+ **Required** you can copy private_key from your `ssh_private_key.pem file`, keep format, and save at`repo/settings/secrets`
+
+
+![](./resource/secret.jpg)
 
 ### `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).
+ **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
+
+ **Required** remote_path
+
+### `sftp_only`
+
+connection via sftp protocol only, the default value is `false`. 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.
 
 ### `args`
-> args of sftp cmd, E.g.`-o ConnectTimeout=5`
+args of sftp cmd, E.g.`-o ConnectTimeout=5`
 
 
-## Example usage	
+## Action Example	
 
 
 	on: [push]
@@ -47,11 +57,81 @@
 	      - name: Checkout
 	        uses: actions/checkout@v2
 	      - name: deploy file
-	        uses: ./ # Uses an action in the root directory
+	        uses: wlixcc/SFTP-Deploy-Action@v1.0
 	        with:
 	          username: 'root'
 	          server: 'your server ip'
-	          private_key: ${{ secrets.SSH_PRIVATE_KEY }} 
+	          ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} 
 	          local_path: './static/*'
-	          remote_path: '/var/www/app' #make sure dir exist
+	          remote_path: '/var/www/app'
 	          args: '-o ConnectTimeout=5'
+
+## 1. [Deploy React App Example](https://github.com/wlixcc/React-Deploy)
+
+> If you use nginx, all you need to do is upload the static files to the server after the project is built
+
+	on: [push]
+	
+	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
+	
+	      - name: Install Dependencies
+	        run: yarn
+	      - name: Build
+	        run: yarn build
+	
+	      - name: deploy file to server
+	        uses: wlixcc/SFTP-Deploy-Action@v1.0
+	        with:
+	          username: 'root'
+	          server: '${{ secrets.SERVER_IP }}'
+	          ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
+	          local_path: './build/*'
+	          remote_path: '/var/www/react-app'
+	          args: '-o ConnectTimeout=5'
+	          
+ ![](./resource/reactExample.jpg)
+ 
+## 2.Deploy Umi App Example (Ant Design Pro)
+
+	name: continuous deployment
+	on: [push]
+	
+	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
+	     
+	      - name: Install umi
+	        run: yarn global add umi  
+	
+	      - name: Install Dependencies
+	        run: yarn
+	      - name: Build
+	        run: yarn build
+	
+	      - name: deploy file to server
+	        uses: wlixcc/SFTP-Deploy-Action@v1.0
+	        with:
+	          username: 'root'
+	          server: '${{ secrets.SERVER_IP }}'
+	          ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
+	          local_path: './dist/*'
+	          remote_path: '/var/www/umiapp'
+	          args: '-o ConnectTimeout=5'
+ ![](./resource/umiExample.jpg)
+	          
+
+ 
+ 
+ 	          

action.yml

@@ -23,6 +23,10 @@ inputs:
     description: 'files will copy to under remote_path'
     required: true
     default: /
+  sftp_only:
+    description: 'connection via sftp protocol only'
+    required: false
+    default: false
 
   args:
     description: 'sftp args'
@@ -39,6 +43,7 @@ runs:
     - ${{ inputs.ssh_private_key }}
     - ${{ inputs.local_path }}
     - ${{ inputs.remote_path }}
+    - ${{ inputs.sftp_only }}
     - ${{ inputs.args }}
 
 branding:

entrypoint.sh

@@ -12,12 +12,19 @@ printf "%s" "$4" >$TEMP_SSH_PRIVATE_KEY_FILE
 # avoid Permissions too open
 chmod 600 $TEMP_SSH_PRIVATE_KEY_FILE
 
-echo 'sftp start'
+if test $7 = "true"; then
+  echo "Connection via sftp protocol only, skip the command to create a directory"
+else
+  echo 'ssh start'
 
+  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'
 exit 0