chore: readme changes

chore: 8.0.2
fix: reverting printf in favor of echo
2026-09-20 05:35:54 +08:00 · 2025-12-07 12:51:42 +01:00 · 2025-12-07 12:49:52 +01:00 · 2025-12-07 12:36:01 +01:00 · 2025-12-07 12:33:49 +01:00 · 2025-12-07 12:31:06 +01:00
6 changed files with 70 additions and 107 deletions
@@ -1 +0,0 @@
-github: [burnett01]
@@ -1,4 +1,4 @@
-FROM alpine:3.23.4@sha256:5b10f432ef3da1b8d4c7eb6c487f2f5a8f096bc91145e68878dd4a5019afde11 AS base
+FROM alpine:3.23.0@sha256:51183f2cfa6320055da30872f211093f9ff1d3cf06f39a0bdb212314c5dc7375 AS base

 RUN apk update && apk add --no-cache --upgrade rsync openssh openssl busybox

@@ -1,8 +1,8 @@
 MIT License

 Copyright (c) 2019-2022 Contention
-Copyright (c) 2019-2026 Joshua Piper (Dr Internet)
-Copyright (c) 2019-2026 Burnett01
+Copyright (c) 2019-2025 Joshua Piper (Dr Internet)
+Copyright (c) 2019-2025 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
@@ -10,51 +10,13 @@ This cross-platform GitHub Action deploys files in [`path`](#inputs) (relative t

 Use this action in a CD workflow which leaves deployable code in `GITHUB_WORKSPACE`, such [actions/checkout](https://github.com/actions/checkout).

-The base-image of this action is very small and based on **Alpine 3.23.4** (no cache) which results in fast deployments.
+The base-image of this action is very small and based on **Alpine 3.23.0** (no cache) which results in fast deployments.

-Alpine version: [3.23.4](https://www.alpinelinux.org/posts/Alpine-3.20.10-3.21.7-3.22.4-3.23.4-released.html)
+Alpine version: [3.23.0](https://www.alpinelinux.org/posts/Alpine-3.23.0-released.html)
 Rsync version: [3.4.1-r1](https://download.samba.org/pub/rsync/NEWS#3.4.1)

-## Current Version: v8 (8.0.5)
-
-### Release channels:
-
-| Version | Purpose          | Immutable  | 
-| ------- | ------------------ | ------------------ | 
-| ``v8`` (recommended)  |  latest MAJOR (pointer to 8.MINOR.PATCH) | no |
-| 8.0.5  | latest MINOR+PATCH | yes |
-| 7.1.0   | previous MAJOR+MINOR ([deprecation notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) | yes |
-| 7.0.2   | previous MAJOR+PATCH ([deprecation notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) | no |
-
-Check [SECURITY.md](SECURITY.md) for support cycles.
-
 ---

-## How it works
-
-```yml
-name: DEPLOY
-on:
-  push:
-    branches:
-    - master
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v6
-    - name: rsync deployments
-      uses: burnett01/rsync-deployments@v8
-      with:
-        switches: -avzr --delete
-        path: src/
-        remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
-        remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
-        remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
-        remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
-        remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
-```
-
 ## Inputs

 - `debug`* - Whether to enable debug output. ("true" / "false") - Default: "false"
@@ -91,9 +53,19 @@ This action needs secret variables for the ssh private key of your key pair. The

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

-## Example usage
+## Current Version: v8 (8.0.2)

-For better **security** always use secrets for remote_host, remote_port, remote_user and remote_path inputs.
+### Release channels:
+
+| Version | Purpose          | Immutable  | 
+| ------- | ------------------ | ------------------ | 
+| ``v8``  |  latest release (pointer to 8.x.x) | no, points to latest MINOR,PATCH |
+| 8.0.2  | latest major release | yes |
+| 7.1.0   | previous release | yes |
+
+Check [SECURITY.md](SECURITY.md) for support cycles.
+
+## Example usage

 Simple:

@@ -114,14 +86,13 @@ jobs:
      with:
        switches: -avzr --delete
        path: src/
-        remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
-        remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
-        remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
-        remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
+        remote_path: /var/www/html/
+        remote_host: example.com
+        remote_user: debian
        remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
 ```

-Advanced (with filters etc):
+Advanced:

 ```yml
 jobs:
@@ -134,10 +105,30 @@ jobs:
      with:
        switches: -avzr --delete --exclude="" --include="" --filter=""
        path: src/
-        remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
-        remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
-        remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
-        remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
+        remote_path: /var/www/html/
+        remote_host: example.com
+        remote_port: 5555
+        remote_user: debian
+        remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
+```
+
+For better **security**, I suggest you create additional secrets for remote_host, remote_port, remote_user and remote_path inputs.
+
+```yml
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - name: rsync deployments
+      uses: burnett01/rsync-deployments@v8
+      with:
+        switches: -avzr --delete
+        path: src/
+        remote_path: ${{ secrets.REMOTE_PATH }}
+        remote_host: ${{ secrets.REMOTE_HOST }}
+        remote_port: ${{ secrets.REMOTE_PORT }}
+        remote_user: ${{ secrets.REMOTE_USER }}
        remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
 ```

@@ -154,10 +145,10 @@ jobs:
      with:
        switches: -avzr --delete
        path: src/
-        remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
-        remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
-        remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
-        remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
+        remote_path: ${{ secrets.REMOTE_PATH }}
+        remote_host: ${{ secrets.REMOTE_HOST }}
+        remote_port: ${{ secrets.REMOTE_PORT }}
+        remote_user: ${{ secrets.REMOTE_USER }}
        remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
        remote_key_pass: ${{ secrets.REMOTE_PRIVATE_KEY_PASS }}
 ```
@@ -181,10 +172,10 @@ jobs:
        switches: -avzr --delete
        legacy_allow_rsa_hostkeys: "true"
        path: src/
-        remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
-        remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
-        remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
-        remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
+        remote_path: ${{ secrets.REMOTE_PATH }}
+        remote_host: ${{ secrets.REMOTE_HOST }}
+        remote_port: ${{ secrets.REMOTE_PORT }}
+        remote_user: ${{ secrets.REMOTE_USER }}
        remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
 ```

@@ -286,30 +277,6 @@ sudo apk add rsync

 ## Versions

-## Version 8.0.4
-
-Check here: 
-
- https://github.com/Burnett01/rsync-deployments/tree/8.0.4  (alpine 3.23.3)
-
-## Version 8.0.3
-
-Check here: 
-
- https://github.com/Burnett01/rsync-deployments/tree/8.0.3  (alpine 3.23.2)
-
-## Version 8.0.2
-
-Check here: 
-
- https://github.com/Burnett01/rsync-deployments/tree/8.0.2  (alpine 3.23.0)
-
-## Version 8.0.1 (EOL)
-
-Check here: 
-
- https://github.com/Burnett01/rsync-deployments/tree/8.0.1  (alpine 3.23.0)
-
 ## Version 8.0.0 (EOL due to regression -> fixed via 8.0.1 & 8.0.2)

 Check here: 
@@ -397,7 +364,7 @@ Please note that version 1.0 has reached end of life state.
 ## Acknowledgements

 + This project is a fork of [Contention/rsync-deployments](https://github.com/Contention/rsync-deployments)
-+ docker-rsync [JoshPiper/rsync-docker](https://github.com/JoshPiper/rsync-docker)
+ Base image [JoshPiper/rsync-docker](https://github.com/JoshPiper/rsync-docker)

 ---

@@ -6,24 +6,21 @@ The Docker image and code quality are regularly checked for vulnerabilities and

 The following versions are currently being supported with security updates:

-| Version | Supported          | Rsync version          | Alpine version          | Support Until  |
-| ------- | ------------------ | ------------------ | ------------------ | ------------------ | 
-| (``v8``) 8.0.5  | :white_check_mark: | >= 3.4.1-r1 | 3.23.4 | LTS (2026-*) |
-| 8.0.4  | :white_check_mark: | >= 3.4.1-r1 | 3.23.3 | LTS (2026) |
-| 8.0.3  | :white_check_mark: | >= 3.4.1-r1 | 3.23.2 | LTS (2026) |
-| 8.0.2  | :white_check_mark: | >= 3.4.1-r1 | 3.23.0 | LTS (2026) |
-| 8.0.1  | :x: EOL | >= 3.4.1-r1 | 3.23.0 | † Apr, 1st 2026 |
-| 8.0.0  | :x: EOL (due to regression #90) | >= 3.4.1-r1 | 3.23.0 | † Dec, 6th 2025 |
-| 7.1.0  | :warning: DEPRECATED | >= 3.4.1-r0 | 3.22.1 | June, 1st 2026 ([deprecation notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) |
-| 7.0.2   | :warning: DEPRECATED | >= 3.4.0-r0 | 3.22.1 | June, 1st 2026 ([deprecation notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) |
-| 7.0.1   | :x: EOL | < 3.4.0 | 3.22.1 | † Dec, 6th 2025 |
-| 7.0.0   | :x: EOL | < 3.4.0| 3.19.1 | † Dec, 6th 2025 |
-| 6.x   | :x: EOL |< 3.4.0| 3.17.2 | † 2024 |
-| 5.x   | :x: EOL |< 3.4.0| 3.11 - 3.14.1 - 3.15 - 3.16 - 3.17.2 | † 2024 |
-| 4.x   | :x: EOL |< 3.4.0| 3.11 |  † |
-| 3.0   | :x: EOL |< 3.4.0| N/A | † |
-| 2.0   | :x: EOL               |< 3.4.0| Ubuntu | † |
-| 1.0   | :x: EOL               |< 3.4.0| Ubuntu | † |
+| Version | Supported          | Rsync version          | Alpine version          |
+| ------- | ------------------ | ------------------ | ------------------ |
+| 8.0.2  | :white_check_mark: | >= 3.4.1-r1 | 3.23.0 |
+| 8.0.1  | :white_check_mark: | >= 3.4.1-r1 | 3.23.0 |
+| 8.0.0  | :x: EOL (due to regression #90) | >= 3.4.1-r1 | 3.23.0 |
+| 7.1.0  | :white_check_mark: | >= 3.4.1-r0 | 3.22.1 |
+| 7.0.2   | :warning: DEPRECATED | >= 3.4.0-r0 | 3.22.1 |
+| 7.0.1   | :x: EOL | < 3.4.0 | 3.22.1 |
+| 7.0.0   | :x: EOL | < 3.4.0| 3.19.1 |
+| 6.x   | :x: EOL |< 3.4.0| 3.17.2 |
+| 5.x   | :x: EOL |< 3.4.0| 3.11 - 3.14.1 - 3.15 - 3.16 - 3.17.2 |
+| 4.x   | :x: EOL |< 3.4.0| 3.11 |
+| 3.0   | :x: EOL |< 3.4.0| N/A |
+| 2.0   | :x: EOL               |< 3.4.0| Ubuntu |
+| 1.0   | :x: EOL               |< 3.4.0| Ubuntu |

 ### Terminology

@@ -1,5 +1,5 @@
 name: 'Rsync Deployments Action'
-description: 'GitHub Action for deploying code via rsync over ssh securely - used by 5k+ workflows!'
+description: 'GitHub Action for deploying code via rsync over ssh'
 author: 'Burnett01'
 inputs:
  switches:
Author	SHA1	Message	Date
Steven	3e8a824ef9	chore: readme changes	2025-12-07 12:51:42 +01:00
Steven	1512f2079d	chore: 8.0.2	2025-12-07 12:49:52 +01:00
Steven	501415e740	fix: reverting printf in favor of echo Like in commit `2c22263` we are using echo again instead of printf because some runners can't function properly with it.	2025-12-07 12:36:01 +01:00
Steven	1002e5f311	fix: only attempt to create file if it doesn't exist yet On self-hosted runners it can happen that an action (docker container) is cached, resulting in aborting this script because the know_hosts file already exists. This if clause fixes it. Setting permissions is intentionally outside the if clause because in all cases we want to reset perms.	2025-12-07 12:33:49 +01:00
Steven	400135b4a7	fix: only attempt to create dir if not yet exists On self-hosted runners it can happen that an action (docker container) is cached. This leads to the script trying to create the .ssh dir despite it already existing. The action then fails.	2025-12-07 12:31:06 +01:00