https://github.com/gwllx/remote-sync

A GitHub Action to sync files with a remote host using rsync. 🔄
https://github.com/gwllx/remote-sync

actions continuous-deployment continuous-integration deployment github rsync

Last synced: about 2 months ago
JSON representation

A GitHub Action to sync files with a remote host using rsync. 🔄

• Host: GitHub
• URL: https://github.com/gwllx/remote-sync
• Owner: gwllx
• License: mit
• Created: 2023-10-20T15:13:27.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-04T16:06:04.000Z (over 2 years ago)
• Last Synced: 2023-11-04T17:22:02.936Z (over 2 years ago)
• Topics: actions, continuous-deployment, continuous-integration, deployment, github, rsync
• Language: Shell
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Remote Sync

A GitHub Action to sync files with a remote host using rsync.

## Inputs

| Name                           | Description                 |

| ------------------------------ | --------------------------- |

| ``source``                     | Local source directory.     |

| ``target``                     | Remote target directory.    |

| ``host``                       | Remote host name.           |

| ``user``                       | Remote user.                |

| ``key``                        | Private SSH key.            |

| ``args`` [optional] | Additional rsync arguments. |

## Example

```yml

steps:

  - uses: gwllx/remote-sync@v1

    with:

      source: .

      target: /www

      host: ${{ secrets.DEPLOY_HOST }}

      user: ${{ secrets.DEPLOY_USER }}

      key: ${{ secrets.DEPLOY_KEY }}

      args: -rv --delete

```