From 02b1a9758c753a2ad5f9bc72f17d37f6cf9dfb29 Mon Sep 17 00:00:00 2001 From: Steven Date: Sat, 6 Dec 2025 15:23:53 +0000 Subject: [PATCH] chore: readme changes --- README.md | 49 +++++++++++++++++++++++++++++++++++-------------- 1 file changed, 35 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c08303a..6dcb892 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,24 @@ This GitHub Action (amd64) deploys files in `GITHUB_WORKSPACE` to a remote folde Use this action in a CD workflow which leaves deployable code in `GITHUB_WORKSPACE`. -The base-image [drinternet/rsync](https://github.com/JoshPiper/rsync-docker/) of this action is very small and is based on Alpine 3.22.1 (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.22.1](https://alpinelinux.org/posts/Alpine-3.19.8-3.20.7-3.21.4-3.22.1-released.html) -Rsync version: [3.4.1-r0](https://download.samba.org/pub/rsync/NEWS#3.4.1) +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) --- ## Inputs +- `debug`* - Whether to enable debug output. ("true" / "false") - Default: "false" + - `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete` - `rsh` - Remote shell commands -- `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false") +- `strict_hostkeys_checking` - Enables support for strict hostkeys (fingerprint) checking. ("true" / "false") - Default: "false" + +- `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false") - Default: "false" - `path` - The source path. Defaults to GITHUB_WORKSPACE and is relative to it @@ -49,7 +53,17 @@ 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. -## Current Version: 7.1.0 +## Current Version: v8 (8.0.0) + +### Release channels: + +| Version | Purpose | Immutable | +| ------- | ------------------ | ------------------ | +| ``v8`` | latest release (pointer to 8.x.x) | no, points to latest MINOR,PATCH | +| 8.0.0 | latest major release | yes | +| 7.1.0 | previous release | yes | + +Check [SECURITY.md](SECURITY.md) for support cycles. ## Example usage @@ -68,7 +82,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.1.0 + uses: burnett01/rsync-deployments@v8 with: switches: -avzr --delete path: src/ @@ -87,7 +101,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.1.0 + uses: burnett01/rsync-deployments@v8 with: switches: -avzr --delete --exclude="" --include="" --filter="" path: src/ @@ -107,7 +121,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.1.0 + uses: burnett01/rsync-deployments@v8 with: switches: -avzr --delete path: src/ @@ -127,7 +141,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.1.0 + uses: burnett01/rsync-deployments@v8 with: switches: -avzr --delete path: src/ @@ -153,7 +167,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.1.0 + uses: burnett01/rsync-deployments@v8 with: switches: -avzr --delete legacy_allow_rsa_hostkeys: "true" @@ -263,20 +277,27 @@ sudo apk add rsync ## Versions -## Version 7.0.2 +## Version 7.1.0 Check here: -- https://github.com/Burnett01/rsync-deployments/tree/7.0.2 (alpine 3.19.1) +- https://github.com/Burnett01/rsync-deployments/tree/7.1.0 (alpine 3.22.1) + + +## Version 7.0.2 (DEPRECATED) + +Check here: + +- https://github.com/Burnett01/rsync-deployments/tree/7.0.2 (alpine 3.22.1) --- -## Version 7.0.0 & 7.0.1 (DEPRECATED) +## Version 7.0.0 & 7.0.1 (EOL) Check here: - https://github.com/Burnett01/rsync-deployments/tree/7.0.0 (alpine 3.19.1) -- https://github.com/Burnett01/rsync-deployments/tree/7.0.1 (alpine 3.19.1) +- https://github.com/Burnett01/rsync-deployments/tree/7.0.1 (alpine 3.22.1) ---