diff --git a/README.md b/README.md index 2579e19..834974b 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ > Use this action to deploy your files to server using `SSH Private Key` -> 使用此`action`部署你的项目到服务器上,`仅支持密钥对连接` -中文介绍链接:[使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396) +> 使用此`action`部署你的项目到服务器上,中文介绍链接:[使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396) ## 1. Inputs @@ -12,7 +11,7 @@ `username` | yes| | SSH username `server` | yes| | Remote host `port`| yes | 22 | Remote host port -`ssh_private_key`| yes| | You can copy private key from your `ssh_private_key.pem` file, and save to`repo/settings/secrets`![](./resource/secret.jpg) +`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. @@ -24,7 +23,9 @@ > Be careful when use `delete_remote_files`, This will delete remote path folder and all files in it -## Action Examples +----- + +## 2.Action Examples ```yaml on: [push] @@ -69,9 +70,8 @@ jobs: password: ${{ secrets.FTP_PASSWORD }} ``` -## 1. [Deploy React App Example](https://github.com/wlixcc/React-Deploy) +## 3. [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 ```yaml on: [push] @@ -103,37 +103,12 @@ jobs: ![](./resource/reactExample.jpg) -## 2.Deploy Umi App Example (Ant Design Pro) + -------- -```yaml -name: continuous deployment -on: [push] +## 4.Invalid format? You need keep format -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 +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) - - name: Install Dependencies - run: yarn - - name: Build - run: yarn build - - - 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: './dist/*' - remote_path: '/var/www/umiapp' - sftpArgs: '-o ConnectTimeout=5' -``` - ![](./resource/umiExample.jpg) + \ No newline at end of file diff --git a/resource/keepformat.jpg b/resource/keepformat.jpg new file mode 100644 index 0000000..e559b2a Binary files /dev/null and b/resource/keepformat.jpg differ