From e07b616b2e3bf03f99bf4e853c2ca280f3728e51 Mon Sep 17 00:00:00 2001 From: Steven Agyekum Date: Tue, 12 Nov 2019 23:12:20 +0100 Subject: [PATCH] mention new rsh arg --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9ee33ef..57fd707 100644 --- a/README.md +++ b/README.md @@ -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. # 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` -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 @@ -37,12 +39,13 @@ jobs: uses: burnett01/rsync-deployments@master with: switches: -avzr --delete + rsh: "-p ${{ secrets.DEPLOY_PORT }}" excludes: "" path: src/ upload_path: user@example.com:/var/www/html/ env: - DEPLOY_KEY: ${{ secrets.private_key }} + DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }} ```