Hostux/rsync-deployments
1
0
Fork 0
forked from Hostux/github.com_burnett01_rsync-deployments
Code Pull requests Activity

mention includes and filters args

Browse source
This commit is contained in:
Steven Agyekum 2019-11-12 23:39:54 +01:00 committed by GitHub
parent afc3d5d8d4
commit cdb8f481ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -9,17 +9,22 @@ This action would usually follow a build/test action which leaves deployable cod
This action needs a `DEPLOY_KEY` secret variable. This should be the private key part of an ssh key pair. The public key part should be added to the authorized_keys file on the server that receives the deployment. This should be set in the Github secrets section and then referenced as an `env` variable.
# Required ARGs
This action requires 5 args in the `with` block.
This action requires 7 args in the `with` block.
1. `swtiches` - The first is for any initial/required rsync flags, eg: `-avzr --delete`
2. `rsh` - Optional remote shell commands, eg for using a different SSH port: `"-p ${{ secrets.DEPLOY_PORT }}"`
3. `excludes` - Any `--exclude` flags and directory pairs, eg: `--exclude .htaccess --exclude /uploads/`. Use "" if none required.
3. `includes` - Any `--include` flags and directory pairs, eg: `--include .htaccess --include /uploads/`. Use "" if none required.
4. `path` - The source path, if none; use `""`
4. `excludes` - Any `--exclude` flags and directory pairs, eg: `--exclude .htaccess --exclude /uploads/`. Use "" if none required.
5. `upload_path` - The deployment target, and should be in the format: `[USER]@[HOST]:[PATH]`
5. `filters` - Any `--filter` flags. Use "" if none required.
6. `path` - The source path, if none; use `""`
7. `upload_path` - The deployment target, and should be in the format: `[USER]@[HOST]:[PATH]`
# Example usage
@ -40,7 +45,9 @@ jobs:
with:
switches: -avzr --delete
rsh: "-p ${{ secrets.DEPLOY_PORT }}"
includes: ""
excludes: ""
filters: ""
path: src/
upload_path: user@example.com:/var/www/html/