Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miked49er/rsync-deployments
GitHub Action for deploying code via rsync over ssh
https://github.com/miked49er/rsync-deployments
action actions deploy deployment github-actions
Last synced: about 1 month ago
JSON representation
GitHub Action for deploying code via rsync over ssh
- Host: GitHub
- URL: https://github.com/miked49er/rsync-deployments
- Owner: miked49er
- License: mit
- Created: 2020-05-26T19:47:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-05-29T19:22:13.000Z (over 4 years ago)
- Last Synced: 2024-11-29T20:51:18.511Z (about 2 months ago)
- Topics: action, actions, deploy, deployment, github-actions
- Language: Shell
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rsync deployments
This GitHub Action deploys files in `GITHUB_WORKSPACE` to a remote folder via rsync over ssh.
Use this action in a CD workflow which leaves deployable code in `GITHUB_WORKSPACE`.
The base-image is very small (Alpine+Cache) which results in faster deployments.
---
## Inputs
- `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete`
- `rsh` - Remote shell commands
- `path` - The source path. Defaults to GITHUB_WORKSPACE
- `remote_path`* - The deployment target path
- `remote_host`* - The remote host
- `remote_port` - The remote port. Defaults to 22
- `remote_user`* - The remote user
- `remote_key`* - The remote ssh key
``* = Required``
## Required secret
This action needs a `DEPLOY_KEY` secret variable. This should be the private key part of a 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 the `remote_key` input.
## Example usage
Simple:
```
name: DEPLOY
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: rsync deployments
uses: miked49er/[email protected]
with:
switches: -avzr --delete
path: src/
remote_path: /var/www/html/
remote_host: example.com
remote_user: debian
remote_key: ${{ secrets.DEPLOY_KEY }}
```
Advanced:
```
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: rsync deployments
uses: miked49er/[email protected]
with:
switches: -avzr --delete --exclude="" --include="" --filter=""
path: src/
remote_path: /var/www/html/
remote_host: example.com
remote_port: 5555
remote_user: debian
remote_key: ${{ secrets.DEPLOY_KEY }}
```
For better security, I suggest you create additional secrets for remote_host, remote_port and remote_user inputs.
```
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: rsync deployments
uses: miked49er/[email protected]
with:
switches: -avzr --delete
path: src/
remote_path: /var/www/html/
remote_host: ${{ secrets.DEPLOY_HOST }}
remote_port: ${{ secrets.DEPLOY_PORT }}
remote_user: ${{ secrets.DEPLOY_USER }}
remote_key: ${{ secrets.DEPLOY_KEY }}
```
For maximum speed limit the checkout action (``actions/checkout@v1``) to a depth of 1:
```
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
with:
fetch-depth: 1
- name: rsync deployments
uses: miked49er/[email protected]
with:
switches: -avzr --delete
path: src/
remote_path: /var/www/html/
remote_host: ${{ secrets.DEPLOY_HOST }}
remote_port: ${{ secrets.DEPLOY_PORT }}
remote_user: ${{ secrets.DEPLOY_USER }}
remote_key: ${{ secrets.DEPLOY_KEY }}
```
---
## Acknowledgements
+ This project is a fork of [Burnett01/rsync-deployments](https://github.com/Burnett01/rsync-deployments)