forked from Hostux/github.com_burnett01_rsync-deployments

Forgejo/Github Action that deploys code via rsync over ssh

Find a file

Steven Agyekum 9f40ee1996 version 3.0 is EOL (see #23 )		2022-01-01 19:29:16 +01:00
.github	Create dependabot.yml	2021-09-01 12:47:46 +02:00
action.yml	Release/v5 (#13 )	2021-08-02 21:57:01 +02:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2020-06-27 15:55:31 +02:00
CONTRIBUTING.md	Create CONTRIBUTING.md	2020-06-27 15:55:57 +02:00
Dockerfile	Bump drinternet/rsync from v1.3.0 to v1.4.0 (#22 )	2022-01-01 19:07:48 +01:00
entrypoint.sh	Release/v5 (#13 )	2021-08-02 21:57:01 +02:00
LICENSE	Update LICENSE	2022-01-01 19:00:50 +01:00
README.md	version 3.0 is EOL (see #23 )	2022-01-01 19:29:16 +01:00
SECURITY.md	dropped support for 3.0	2022-01-01 19:02:50 +01:00

README.md

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 (drinternet/rsync) of this action is very small and is based on Alpine 3.15.0 (no cache) which results in fast 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
remote_key_pass - The remote ssh key passphrase (if any)

* = Required

Required secret(s)

This action needs secret variables for the ssh private key of your key pair. The public key part should be added to the authorized_keys file on the server that receives the deployment. The secret variable should be set in the Github secrets section of your org/repo and then referenced as the remote_key input.

Always use secrets when dealing with sensitive inputs!

For simplicity, we are using DEPLOY_* as the secret variables throughout the examples.

Example usage

Simple:

name: DEPLOY
on:
  push:
    branches:
    - master

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: rsync deployments
      uses: burnett01/rsync-deployments@5.2
      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@v2
    - name: rsync deployments
      uses: burnett01/rsync-deployments@5.2
      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, remote_user and remote_path inputs.

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: rsync deployments
      uses: burnett01/rsync-deployments@5.2
      with:
        switches: -avzr --delete
        path: src/
        remote_path: ${{ secrets.DEPLOY_PATH }}
        remote_host: ${{ secrets.DEPLOY_HOST }}
        remote_port: ${{ secrets.DEPLOY_PORT }}
        remote_user: ${{ secrets.DEPLOY_USER }}
        remote_key: ${{ secrets.DEPLOY_KEY }}

If your private key is passphrase protected you should use:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: rsync deployments
      uses: burnett01/rsync-deployments@5.2
      with:
        switches: -avzr --delete
        path: src/
        remote_path: ${{ secrets.DEPLOY_PATH }}
        remote_host: ${{ secrets.DEPLOY_HOST }}
        remote_port: ${{ secrets.DEPLOY_PORT }}
        remote_user: ${{ secrets.DEPLOY_USER }}
        remote_key: ${{ secrets.DEPLOY_KEY }}
        remote_key_pass: ${{ secrets.DEPLOY_KEY_PASS }}

Version 4.0 & 4.1

Looking for version 4.0 and 4.1?

Check here:

Version 4.0 & 4.1 use the drinternet/rsync:1.0.1 base-image.

Version 3.0 (EOL)

Looking for version 3.0?

Check here: https://github.com/Burnett01/rsync-deployments/tree/3.0

Version 3.0 uses the alpine:latest base-image directly.
Consider upgrading to 4.0 that uses a docker-image drinternet/rsync:1.0.1 that is
based on alpine:latestand heavily optimized for rsync.

Version 2.0 (EOL)

Looking for version 2.0?

Check here: https://github.com/Burnett01/rsync-deployments/tree/2.0

Version 2.0 uses a larger base-image (ubuntu:latest).
Consider upgrading to 3.0 for even faster deployments.

Version 1.0 (EOL)

Looking for version 1.0?

Check here: https://github.com/Burnett01/rsync-deployments/tree/1.0

Please note that version 1.0 has reached end of life state.

Acknowledgements

This project is a fork of Contention/rsync-deployments
Base image JoshPiper/rsync-docker

Media

This action was featured in multiple blogs across the globe: