Skip to content
refresh-cw

GitHub Action

Remote Sync

v1.0.0 Latest version

Remote Sync

refresh-cw

Remote Sync

Sync files with a remote server using rsync

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Remote Sync

              
  uses: gwllx/[email protected]
Learn more about this action in gwllx/remote-sync

Choose a version

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

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