https://github.com/itk-dev/actions-rsync
https://github.com/itk-dev/actions-rsync
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/itk-dev/actions-rsync
- Owner: itk-dev
- License: agpl-3.0
- Created: 2020-06-29T13:52:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-24T12:13:33.000Z (almost 4 years ago)
- Last Synced: 2025-07-31T06:44:02.297Z (8 months ago)
- Language: Shell
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rsync SSH Commands
Action to rsync file to a remote server using SSH.
## Example
```yml
- name: Run remote command
uses: itk-dev/actions-rsync@master
with:
src: web/themes/aarhus_theme/build
dest: ${{ secrets.PATH }}/web/themes/aarhus_theme/build
host: ${{ secrets.HOST }}
key: ${{ secrets.PRIVATE_KEY }}
cert: ${{ secrets.PUBLIC_KEY_CERT }}
```
You should use GitHub secrest to store the host and private ssh key and the key should be without password.
## Secrets
These options should be create using secrets.
* HOST
* PRIVATE_KEY
* PUBLIC_KEY_CERT
## Options
* src: Source directory (default: $GITHUB_WORKSPACE).
* dest: Remote destionation directory
* host: FQDN - Server hostname
* user: Remote SSH username (default: deploy)
* port: Remote port number (default 22)
* key: File Location or string that contains a private key
* cert: Public signed certificate
* args: Extra SSH parameters