actions
/
burnett01-rsync-deployments
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Steven Agyekum 2019-12-04 19:02:32 +01:00 committed by GitHub
parent 0186c3a6b2
commit 6093fd5ca1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -11,7 +11,7 @@ Use this action in a build/test workflow which leaves deployable code in `GITHUB
- `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete` - `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete`
- `rsh` - Remote shell commands, eg for using a different SSH port: `"-p ${{ secrets.DEPLOY_PORT }}"` - `rsh` - Remote shell commands
- `path` - The source path. Defaults to GITHUB_WORKSPACE - `path` - The source path. Defaults to GITHUB_WORKSPACE
@ -76,15 +76,15 @@ jobs:
uses: burnett01/rsync-deployments@2.0 uses: burnett01/rsync-deployments@2.0
with: with:
switches: -avzr --delete --exclude="" --include="" --filter="" switches: -avzr --delete --exclude="" --include="" --filter=""
rsh: "-p ${{ secrets.DEPLOY_PORT }}"
path: src/ path: src/
remote_path: /var/www/html/ remote_path: /var/www/html/
remote_host: example.com remote_host: example.com
remote_port: ${{ secrets.DEPLOY_PORT }}
remote_user: debian remote_user: debian
remote_key: ${{ secrets.DEPLOY_KEY }} remote_key: ${{ secrets.DEPLOY_KEY }}
``` ```
For better security, I suggest you create additional secrets for remote_host and remote_user inputs. For better security, I suggest you create additional secrets for remote_host, remote_port and remote_user inputs.
``` ```
name: DEPLOY name: DEPLOY
@ -105,6 +105,7 @@ jobs:
path: src/ path: src/
remote_path: /var/www/html/ remote_path: /var/www/html/
remote_host: ${{ secrets.DEPLOY_HOST }} remote_host: ${{ secrets.DEPLOY_HOST }}
remote_port: ${{ secrets.DEPLOY_PORT }}
remote_user: ${{ secrets.DEPLOY_USER }} remote_user: ${{ secrets.DEPLOY_USER }}
remote_key: ${{ secrets.DEPLOY_KEY }} remote_key: ${{ secrets.DEPLOY_KEY }}
``` ```