From cdb8f481eaba70b1f2bf0169dc0729ecee9e8e92 Mon Sep 17 00:00:00 2001 From: Steven Agyekum Date: Tue, 12 Nov 2019 23:39:54 +0100 Subject: [PATCH] mention includes and filters args --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 57fd707..5a65bb2 100644 --- a/README.md +++ b/README.md @@ -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/