Hostux/github.com_burnett01_rsync-deployments
1
0
Fork 1
mirror of https://github.com/Burnett01/rsync-deployments.git synced 2024-11-21 23:13:46 +01:00
Code Issues Projects Releases Packages Wiki Activity

mention new rsh arg

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

13
README.md
View file

@ -9,15 +9,17 @@ 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. 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 # Required ARGs
This action requires 4 args in the `with` block. This action requires 5 args in the `with` block.
1. `swtiches` - The first is for any initial/required rsync flags, eg: `-avzr --delete` 1. `swtiches` - The first is for any initial/required rsync flags, eg: `-avzr --delete`
2. `excludes` - Any `--exclude` flags and directory pairs, eg: `--exclude .htaccess --exclude /uploads/`. Use "" if none required. 2. `rsh` - Optional remote shell commands, eg for using a different SSH port: `"-p ${{ secrets.DEPLOY_PORT }}"`
3. `path` - The path to your desired directory to be deployed, if none; use `""` 3. `excludes` - Any `--exclude` flags and directory pairs, eg: `--exclude .htaccess --exclude /uploads/`. Use "" if none required.
4. `upload_path` - The deployment target, and should be in the format: `[USER]@[HOST]:[PATH]` 4. `path` - The source path, if none; use `""`
5. `upload_path` - The deployment target, and should be in the format: `[USER]@[HOST]:[PATH]`
# Example usage # Example usage
@ -37,12 +39,13 @@ jobs:
uses: burnett01/rsync-deployments@master uses: burnett01/rsync-deployments@master
with: with:
switches: -avzr --delete switches: -avzr --delete
rsh: "-p ${{ secrets.DEPLOY_PORT }}"
excludes: "" excludes: ""
path: src/ path: src/
upload_path: user@example.com:/var/www/html/ upload_path: user@example.com:/var/www/html/
env: env:
DEPLOY_KEY: ${{ secrets.private_key }} DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
``` ```