Changes in 4.0

Feat/rsync image

Dockerfile

@@ -1,12 +1,7 @@
-FROM ubuntu:latest
+FROM drinternet/rsync:1.0.1
-
-# Update
-RUN apt-get update
-
-# Install packages
-RUN apt-get -yq install rsync openssh-client
 
 # Copy entrypoint
-ADD entrypoint.sh /entrypoint.sh
+COPY entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
+
 ENTRYPOINT ["/entrypoint.sh"]

LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
-Copyright (c) 2019 Contention
+Copyright (c) 2019-2020 Contention
-Copyright (c) 2019 Burnett01
+Copyright (c) 2019-2020 Burnett01
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -3,9 +3,11 @@
 Forked from [Contention/rsync-deployments](https://github.com/Contention/rsync-deployments)
 
 
-This GitHub Action deploys files in `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh. 
+This GitHub Action deploys files in `GITHUB_WORKSPACE` to a remote folder via rsync over ssh. 
 
-Use this action in a build/test workflow which leaves deployable code in `GITHUB_WORKSPACE`.
+Use this action in a CD workflow which leaves deployable code in `GITHUB_WORKSPACE`.
+
+The underlaying base-image of the docker-image is very small (Alpine (no cache)) which results in fast deployments.
 
 ---
 
@@ -50,7 +52,7 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - name: rsync deployments
-      uses: burnett01/rsync-deployments@2.0
+      uses: burnett01/rsync-deployments@4.0
       with:
         switches: -avzr --delete
         path: src/
@@ -63,19 +65,13 @@ jobs:
 Advanced:
 
 ```
-name: DEPLOY
-on:
-  push:
-    branches:
-    - master
-
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - name: rsync deployments
-      uses: burnett01/rsync-deployments@2.0
+      uses: burnett01/rsync-deployments@4.0
       with:
         switches: -avzr --delete --exclude="" --include="" --filter=""
         path: src/
@@ -89,19 +85,35 @@ jobs:
 For better security, I suggest you create additional secrets for remote_host, remote_port and remote_user inputs.
 
 ```
-name: DEPLOY
-on:
-  push:
-    branches:
-    - master
-
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - name: rsync deployments
-      uses: burnett01/rsync-deployments@2.0
+      uses: burnett01/rsync-deployments@4.0
+      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 2:
+
+```
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 2
+    - name: rsync deployments
+      uses: burnett01/rsync-deployments@4.0
       with:
         switches: -avzr --delete
         path: src/
@@ -114,6 +126,25 @@ jobs:
 
 ---
 
+## Version 3.0
+
+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.<br>
+Consider upgrading to 4.0 that uses a docker-image ``drinternet/rsync:1.0.1`` that is<br>
+based on ``alpine:latest``and heavily optimized for rsync.
+
+## Version 2.0
+
+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``).<br>
+Consider upgrading to 3.0 for even faster deployments.
+
 ## Version 1.0 (EOL)
 
 Looking for version 1.0?

entrypoint.sh

@@ -1,18 +1,9 @@
-#!/bin/bash
+#!/bin/sh
 
+# Start the SSH agent and load key.
+source agent-start "$GITHUB_ACTION"
+echo "$INPUT_REMOTE_KEY" | agent-add
+
+# Add strict errors and deploy.
 set -eu
-
+sh -c "rsync $INPUT_SWITCHES -e 'ssh -o StrictHostKeyChecking=no -p $INPUT_REMOTE_PORT $INPUT_RSH' $GITHUB_WORKSPACE/$INPUT_PATH $INPUT_REMOTE_USER@$INPUT_REMOTE_HOST:$INPUT_REMOTE_PATH"
-# Set deploy key
-SSH_PATH="$HOME/.ssh"
-
-# Create .ssh dir if it doesn't exist
-[ -d "$SSH_PATH" ] || mkdir "$SSH_PATH"
-
-# Place deploy_key into .ssh dir
-echo "$INPUT_REMOTE_KEY" > "$SSH_PATH/key"
-
-# Set r+w to user only
-chmod 600 "$SSH_PATH/key"
-
-# Do deployment
-sh -c "rsync $INPUT_SWITCHES -e 'ssh -i $SSH_PATH/key -o StrictHostKeyChecking=no -p $INPUT_REMOTE_PORT $INPUT_RSH' $GITHUB_WORKSPACE/$INPUT_PATH $INPUT_REMOTE_USER@$INPUT_REMOTE_HOST:$INPUT_REMOTE_PATH"