Compare commits

...

33 Commits

Author SHA1 Message Date
Burnett01 37c76ba59c chore: README for clarity on inputs
Updated README to clarify options. Added section on pinning trusted host keys.
2026-11-15 11:12:29 +01:00
Burnett01 7abe7ad2ed refactor: deprecate strict_hostkeys_checking and add known_hosts
Updated description for strict_hostkeys_checking to indicate deprecation and added known_hosts parameter.
2026-11-15 10:41:05 +01:00
Burnett01 fb178094f6 refactor: new 'known_hosts', deprecate 'strict_hostkeys_checking'
Updated strict hostkeys checking logic: 
From now on you should use 'known_hosts' input, if you want to enforce explicit strict hostkey checking. Just create a new action secret which contains the explicit known_hosts entry you want this actions rsync-rsh to enforce. Multiple formats are supported.

The deprecated 'strict_hostkeys_checking' input will be a no-op in the next major because it is weak. It relies on ssh-keyscan which is fetching and validating the hostkey, but not verifying it against a user supplied hostkey. This is what the new 'known_hosts' input covers.
2026-11-15 10:33:27 +01:00
Burnett01 458d542ef0 refactor: log_level input to action.yml
Add log_level input to configure logging level
2026-11-15 09:43:38 +01:00
Burnett01 72af351b83 feat: new input for dynamic LOG_LEVEL
You can now control the ssh log-level that is passed via the rsh switch for better logging control.

The default log-level is ERROR (previously it was not set, hence it fallback to INFO). 

This further enhances masking when strict_hostkeys_checking is false (default=false), by hiding the warning message.
Github already always masked the host but the algo was still visible.

Before: "Warning: Permanently added '***' (ED25519) to the list of known hosts."

After: hidden (when log_level ERROR, which is the default)

As always, we encourage you to enable strict_hostkeys_checking = true, in order to make a hostkey known to the action beforehand.
2026-11-15 09:41:49 +01:00
Burnett01 a45ed8d36c chore: update versioning details in SECURITY.md
Clarified versioning scheme for action in the documentation.
2026-11-14 14:42:28 +01:00
Burnett01 b6ac3fe34e chore: Updated the status for v8 8.0.5 to indicate ESU.
Updated the status for v8 8.0.5 to indicate ESU.
2026-11-14 13:56:50 +01:00
Burnett01 2292b0b93b chore. Update support until date for version 9.0.3 2026-11-14 13:55:22 +01:00
Burnett01 b8733f9f81 Release/9.0.4 (#118)
* feat: update alpine to 3.24.4, update rsync to 3.5.2-r1, update openssh via edge to version 10.6_p2-r0

* feat: use alpine openssh-client pkg instead of full openssh (server+client pkg)

* Openssh now uses the openssh-client-default package, rather than the full openssh package, because openssh-server and other sub-packages are not needed for this action. This results in better security and faster deployments, since less dependencies are needed.

*  openssh-client-default package is using the edge repo now, just like rsync, in order to get the latest alpine security updates for them

* chore: update supported versions in SECURITY.md

* chore: update action version to 9.0.4, also mention new additional channel "latest"

+ Updated Alpine and Rsync versions in README.
+ New release channel available: @latest (always points to latest major, eg. v9, v10, v11....)
2026-11-08 18:37:35 +01:00
Burnett01 c8300118e5 Release/9.0.3 (#116)
* chore(deps): bump alpine from 3.24.2 to 3.24.3 (#115)

Bumps alpine from 3.24.2 to 3.24.3.

---
updated-dependencies:
- dependency-name: alpine
  dependency-version: 3.24.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: update to version 9.0.3

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-11-05 18:18:02 +01:00
Burnett01 2cbb5ed94b Release/9.0.2 (#113)
Alpine and Rsync have received new updates:

* feat: Update Alpine from 3.24.1 to 3.24.2

Release notes: https://alpinelinux.org/posts/Alpine-3.21.8-3.22.6-3.23.6-3.24.2-released.html

* feat: Update Rsync from 3.5.0 to 3.5.1

Release notes: https://download.samba.org/pub/rsync/NEWS#3.5.1

* feat: install rsync from Alpine edge branch for latest security patches when base branch lacks behind

* chore: Update supported versions in SECURITY.md

* feat: add integration workflow for tests

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-14 17:49:45 +02:00
Burnett01 3fc2e3250f chore: mark 8.0.2, 8.0.3, 8.0.4 older versions as deprecated
Updated deprecated versions in the security table.
2026-09-08 16:37:28 +02:00
Burnett01 155b6d6c12 Release/9.0.1 (#107)
* feat: upgrade rsync to 3.5.0-r0

Rsync released version 3.5.0 with a ton of CVE fixes.

https://download.samba.org/pub/rsync/NEWS#3.5.0

- CVE-2026-53802 (HIGH)
- CVE-2026-53803 (HIGH)
- CVE-2026-53785 (HIGH)
- CVE-2026-53784 (HIGH)
- CVE-2026-53793 (HIGH)
- CVE-2026-53795 (HIGH)
- CVE-2026-53796 (MEDIUM)
- CVE-2026-53797 (MEDIUM)
- CVE-2026-53799 (MEDIUM)
- CVE-2026-53800 (MEDIUM)
- CVE-2026-53801 (MEDIUM)
- CVE-2026-53783 (HIGH)
- CVE-2026-53786 (MEDIUM)
- CVE-2026-53798 (MEDIUM)
- CVE-2026-53788 (MEDIUM)
- CVE-2026-53789 (MEDIUM)
- CVE-2026-53791 (CRITICAL)
- CVE-2026-53790 (HIGH)
- CVE-2026-53792 (MEDIUM)
- CVE-2026-53794 (MEDIUM)
- CVE-2026-70461 (HIGH)
- CVE-2026-70458 (HIGH)
- CVE-2026-70456 (HIGH)
- CVE-2026-70457 (MEDIUM)
- CVE-2026-70459 (MEDIUM)
- CVE-2026-70464 (HIGH)
- CVE-2026-70455 (HIGH)
- CVE-2026-70453 (HIGH)
- CVE-2026-70452 (HIGH)
- CVE-2026-70463 (HIGH)
- CVE-2026-70460 (HIGH)
- CVE-2026-70462 (MEDIUM)
- CVE-2026-70454 (MEDIUM

* chore: update supported version from 9.0.0 to 9.0.1

* chore: Update README with new rsync and version information
2026-09-04 19:46:02 +02:00
Burnett01 4d419d1dc4 Release/9.0.0 (v9) (#105)
* feat: Upgrade Alpine base image to version 3.24.1

* chore: Update supported versions and their statuses

* chore: Update README with new versions and action updates

Updated the README to reflect changes in Alpine and Rsync versions, and updated the action versions from v8 to v9.

* chore: Update Alpine version in README.md
2026-06-22 22:35:49 +02:00
dependabot[bot] 32988e12ed chore(deps): bump actions/checkout from 4 to 7 (#104)
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 7.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4...v7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-22 22:15:50 +02:00
Burnett01 003130719f chore: Add GitHub Actions to Dependabot configuration 2026-06-22 21:46:51 +02:00
Burnett01 0467ec3563 chore!: EOL of version 7.0.2 and 7.1.0 (#102)
* chore: EOL of version 7.0.2 and 7.1.0
2026-06-01 13:37:22 +02:00
Burnett01 66257cad6b Release/8.0.5 (#101)
* feat: Update base image to Alpine 3.23.4

Alpine 3.23.4 fixes the following:

musl
CVE-2026-6042
CVE-2026-40200

openssl
CVE-2026-31790
CVE-2026-28387
CVE-2026-28388
CVE-2026-28389
CVE-2026-28390
CVE-2026-31789

* chore: Update supported versions in SECURITY.md

* chore: Update README for Alpine and version changes

* chore: Update copyright years in LICENSE file

Updated copyright years for Joshua Piper and Burnett01.
2026-04-17 18:50:35 +02:00
Steven 27212fc826 chore(readme): Version upgrade to 8.0.4 2026-02-04 20:48:49 +01:00
Steven dc0d5d44c4 Release/8.0.4 (#100)
* chore(deps): bump alpine from 3.23.2 to 3.23.3 (#99)

Bumps alpine from 3.23.2 to 3.23.3.

---
updated-dependencies:
- dependency-name: alpine
  dependency-version: 3.23.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat(action): Version 8.0.4 (alpine upgrade 3.23.3)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-02-04 20:38:53 +01:00
Steven cccc35d762 chore(action): update description to match modern facts 2026-01-15 23:15:06 +01:00
Steven 2ad5f95a8a chore(funding): create funding yaml 2026-01-15 23:12:32 +01:00
Steven 115573f97b chore(readme): mention deprecation of 7.0.2 too 2026-01-15 22:59:55 +01:00
Steven 7659d600d8 feat(release): 8.0.3 (v8) - bump alpine from 3.23.0 to 3.23.2 (#97) (#98)
* chore(deps): bump alpine from 3.23.0 to 3.23.2

Bumps alpine from 3.23.0 to 3.23.2.

---
updated-dependencies:
- dependency-name: alpine
  dependency-version: 3.23.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...



* chore(docs): update Alpine version to 3.23.2 in README and SECURITY files

* chore(docs): update current version to 8.0.3 in README

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-01-02 21:55:43 +01:00
Steven 81be6cf6d7 chore: add deprecation notice, move release channels to top 2025-12-09 21:22:31 +01:00
Steven 178d2ea600 chore: deprecation notice 2025-12-09 14:45:28 +01:00
Steven 241aa321a8 chore: add support cycles 2025-12-07 14:02:36 +01:00
Steven 80e4fa792e chore: update readme
- advise users to always use secrets
- simplified examples
- other adjustments
2025-12-07 13:51:46 +01:00
Steven 0c902521b8 Release/8.0.2 (#93)
* 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.

* 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.

* 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.

* chore: 8.0.2

* chore: readme changes
2025-12-07 12:59:02 +01:00
Steven 68d1fd5150 chore: 8.0.1 2025-12-06 21:44:40 +00:00
Steven 2c22263f9c fix: regression - using echo instead of printf again #90
It was found via #90 and #89 that using printf causes problems.
In the previous version 7.1.0 we used echo instead of printf - hence we are bringing this back for version 8.0.x
2025-12-06 22:33:01 +01:00
Steven 8a39558686 feat: add README for SSH agent and known_hosts management scripts 2025-12-06 19:19:48 +00:00
Steven 0f1cb7924d fix: permissions of docker-rsync scripts 2025-12-06 19:19:26 +00:00
15 changed files with 368 additions and 107 deletions
+1
View File
@@ -0,0 +1 @@
github: [burnett01]
+4
View File
@@ -4,3 +4,7 @@ updates:
directory: /
schedule:
interval: monthly
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
@@ -23,7 +23,7 @@ jobs:
name: Test BATS Suite
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v7
- name: Install BATS
run: |
@@ -38,7 +38,7 @@ jobs:
name: Validate Action Definition
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v7
- name: Validate action.yml
run: |
@@ -81,7 +81,7 @@ jobs:
needs: [validate-action, action-structure]
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v7
- name: Build Docker image
run: |
@@ -94,7 +94,7 @@ jobs:
name: Validate Action Structure
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v7
- name: Check required files
run: |
@@ -128,7 +128,7 @@ jobs:
name: Lint Shell Scripts
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v7
- name: Install ShellCheck
run: |
@@ -151,7 +151,7 @@ jobs:
needs: [test, validate-action, docker-build, action-structure, lint-shell]
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v7
- name: Final integration check
run: |
+25
View File
@@ -0,0 +1,25 @@
name: Integration
on:
workflow_dispatch:
permissions:
contents: read
jobs:
integration-test:
if: github.actor == 'Burnett01'
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v7
- name: Run integration test
uses: ./
with:
switches: -avzr --dry-run
remote_path: ${{ secrets.INTEGRATION_TEST_PATH }}
remote_host: ${{ secrets.INTEGRATION_TEST_SERVER }}
remote_port: ${{ secrets.INTEGRATION_TEST_PORT }}
remote_user: ${{ secrets.INTEGRATION_TEST_USER }}
remote_key: ${{ secrets.INTEGRATION_TEST_KEY }}
remote_key_pass: ${{ secrets.INTEGRATION_TEST_KEY_PASSPHRASE }}
@@ -19,7 +19,7 @@ jobs:
actions: read
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Build a Docker image
run: docker build -t burnett01/rsync-deployments .
- name: Run Snyk to check Docker image for vulnerabilities
+11 -3
View File
@@ -1,11 +1,19 @@
FROM alpine:3.23.0@sha256:51183f2cfa6320055da30872f211093f9ff1d3cf06f39a0bdb212314c5dc7375 AS base
FROM alpine:3.24.4@sha256:f59abe656b692d901e184be3445e084786602108599d2a51d229c0f5a48c71bf AS base
RUN apk update && apk add --no-cache --upgrade rsync openssh openssl busybox
# Add Alpine edge branch as tagged repository for rsync.
RUN printf '%s\n' \
'@edge https://dl-cdn.alpinelinux.org/alpine/edge/main' \
'@edge https://dl-cdn.alpinelinux.org/alpine/edge/community' \
>> /etc/apk/repositories
# Install rsync from Alpine edge branch for latest upstream security patches.
# Other packages are installed from Alpine 3.24.3 branch.
RUN apk update && apk add --no-cache --upgrade 'rsync@edge>=3.5.2-r1' 'openssh-client-default@edge>=10.6_p2-r0' openssl busybox
RUN rm -rf /var/cache/apk/*
COPY docker-rsync/* /bin/
RUN chmod +x /bin/agent-*
RUN chmod +x /bin/agent-* /bin/ssh-* /bin/hosts-*
FROM base AS build
+2 -2
View File
@@ -1,8 +1,8 @@
MIT License
Copyright (c) 2019-2022 Contention
Copyright (c) 2019-2025 Joshua Piper (Dr Internet)
Copyright (c) 2019-2025 Burnett01
Copyright (c) 2019-2026 Joshua Piper (Dr Internet)
Copyright (c) 2019-2026 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
+170 -73
View File
@@ -10,22 +10,63 @@ 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.0** (no cache) which results in fast deployments.
The base-image of this action is very small and based on **Alpine 3.24.4** (no cache) which results in fast deployments.
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)
Alpine version: [3.24.4](https://alpinelinux.org/posts/alpine-3.21.10-3.22.8-3.23.8-3.24.4-released/)
Rsync version: [3.5.2-r1](https://download.samba.org/pub/rsync/NEWS#3.5.2)
## Current Version: v9 (9.0.4)
### Release channels:
| Version | Purpose | Immutable |
| ------- | ------------------ | ------------------ |
| ``@v9`` (recommended, LTS) | latest MAJOR (pointer to 9.MINOR.PATCH) | no |
| ``@9.0.4`` | latest MAJOR+MINOR+PATCH | yes |
| ``@v8`` (ESU) | previous MAJOR (pointer to 8.MINOR.PATCH) | no |
| ``@8.0.5`` | previous MAJOR+MINOR+PATCH | yes |
You can also use ``@latest`` which always points to the latest MAJOR (currently ``v9``).
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@v7
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
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"
- `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete`
- `rsh` - Remote shell commands
- `rsh` - Custom remote shell SSH parameters via Rsync.
- `strict_hostkeys_checking` - Enables support for strict hostkeys (fingerprint) checking. ("true" / "false") - Default: "false"
- `strict_hostkeys_checking` - Enables support for strict hostkeys (fingerprint) checking. ("true" / "false") - Default: "false" - **DEPRECATED (use 'known_hosts')!**
- `known_hosts` - Trusted host keys of the remote server, one per line (pinning). Enables strict hostkeys checking. Takes precedence over `strict_hostkeys_checking` - Default: "" - [See guide](#pinning-trusted-host-keys-known_hosts)
- `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false") - Default: "false"
@@ -53,20 +94,10 @@ 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: 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
For better **security** always use secrets for remote_host, remote_port, remote_user and remote_path inputs.
Simple:
```yml
@@ -80,56 +111,32 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v7
- name: rsync deployments
uses: burnett01/rsync-deployments@v8
uses: burnett01/rsync-deployments@v9
with:
switches: -avzr --delete
path: src/
remote_path: /var/www/html/
remote_host: example.com
remote_user: debian
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 }}
```
Advanced:
Advanced (with filters etc) use ``switches``:
```yml
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v7
- name: rsync deployments
uses: burnett01/rsync-deployments@v8
uses: burnett01/rsync-deployments@v9
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.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 }}
[...redacted...]
```
If your private key is passphrase protected you should use:
@@ -139,23 +146,58 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v7
- name: rsync deployments
uses: burnett01/rsync-deployments@v8
uses: burnett01/rsync-deployments@v9
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 }}
[...redacted...]
remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
remote_key_pass: ${{ secrets.REMOTE_PRIVATE_KEY_PASS }}
```
---
#### Legacy RSA Hostkeys support for OpenSSH Servers >= 8.8+
## Pinning trusted host keys (known_hosts)
By default the action accepts any host key the server presents. With ``strict_hostkeys_checking: "true"`` (deprecated)
the key is fetched via `ssh-keyscan` right before the deployment, which only protects against
the key changing during the run, not against a server that is already spoofed at that moment.
To actually verify the server, pass its host key(s) via ``known_hosts``. The action then enables strict checking and skips `ssh-keyscan`. If the server presents
a different key, the deployment fails.
Get the public host key on the server itself (not over the network):
```sh
cat /etc/ssh/ssh_host_ed25519_key.pub
# ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... user@server
```
Store the output in a secret (e.g. `REMOTE_HOST_KEYS`) and pass it to the action:
```yml
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- name: rsync deployments
uses: burnett01/rsync-deployments@v9
with:
[...redacted...]
known_hosts: ${{ secrets.REMOTE_HOST_KEYS }}
```
Accepted formats, one entry per line (blank lines and lines starting with `#` are ignored):
- Bare key, e.g. `ssh-ed25519 AAAAC3...`. It is bound to `remote_host` (and `remote_port`, if not 22) automatically.
- Full known_hosts line, e.g. `example.com ssh-ed25519 AAAAC3...` or a hashed `|1|...` line. Used as is, so the host part must match `remote_host`.
Multiple keys (e.g. ed25519 and ecdsa) can be listed on separate lines.
---
## Legacy RSA Hostkeys support for OpenSSH Servers >= 8.8+
If your remote OpenSSH Server still uses RSA hostkeys, then you have to
manually enable legacy support for this by using ``legacy_allow_rsa_hostkeys: "true"``.
@@ -165,25 +207,19 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v7
- name: rsync deployments
uses: burnett01/rsync-deployments@v8
uses: burnett01/rsync-deployments@v9
with:
switches: -avzr --delete
[...redacted...]
legacy_allow_rsa_hostkeys: "true"
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 }}
```
See [#49](https://github.com/Burnett01/rsync-deployments/issues/49) and [#24](https://github.com/Burnett01/rsync-deployments/issues/24) for more information.
**Note:** Only use this if necessary. It's recommended to upgrade your remote OpenSSH server instead.
--
---
## Advanced Rsync switches/flags/options
@@ -277,14 +313,75 @@ sudo apk add rsync
## Versions
## Version 7.1.0
## Version 9.0.3
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.3 (alpine 3.24.3)
## Version 9.0.2
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.2 (alpine 3.24.2)
## Version 9.0.1
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.1 (alpine 3.24.1)
## Version 9.0.0
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/9.0.0 (alpine 3.24.1)
## Version 8.0.5
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.5 (alpine 3.23.4)
## 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:
- https://github.com/Burnett01/rsync-deployments/tree/8.0.0 (alpine 3.23.0)
## Version 7.1.0 (EOL)
Check here:
- https://github.com/Burnett01/rsync-deployments/tree/7.1.0 (alpine 3.22.1)
## Version 7.0.2 (DEPRECATED)
## Version 7.0.2 (EOL)
Check here:
@@ -358,7 +455,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)
+ Base image [JoshPiper/rsync-docker](https://github.com/JoshPiper/rsync-docker)
+ docker-rsync [JoshPiper/rsync-docker](https://github.com/JoshPiper/rsync-docker)
---
+56 -13
View File
@@ -2,23 +2,35 @@
The Docker image and code quality are regularly checked for vulnerabilities and CVEs by Snyk and CodeQL.
Additionally, we run linter and BATS suite tests to ensure stable compatibility.
## Supported Versions
The following versions are currently being supported with security updates:
| Version | Supported | Rsync version | Alpine version |
| ------- | ------------------ | ------------------ | ------------------ |
| 8.0.0 | :white_check_mark: | >= 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 |
| Version | Supported | Rsync version | Alpine version | Support Until |
| ------- | ------------------ | ------------------ | ------------------ | ------------------ |
| (``v9``) 9.0.4 | :white_check_mark: | >= 3.5.2-r1 | 3.24.4 | LTS (2028-*) |
| 9.0.3 | :white_check_mark: | >= 3.5.1-r0 | 3.24.3 | LTS (Jan, 8th 2028) |
| 9.0.2 | :white_check_mark: | >= 3.5.1-r0 | 3.24.2 | LTS (Jan, 8th 2028) |
| 9.0.1 | :white_check_mark: | >= 3.5.0-r0 | 3.24.1 | LTS (Jan, 8th 2028) |
| 9.0.0 | :white_check_mark: | >= 3.4.3-r1 | 3.24.1 | LTS (Jan, 8th 2028) |
| (``v8``) 8.0.5 | ⚠️ ESU | >= 3.4.1-r1 | 3.23.4 | Apr, 1st 2027 ([esu notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 8.0.4 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.3 | Dec, 6th 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 8.0.3 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.2 | Dec, 6th 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 8.0.2 | :warning: DEPRECATED | >= 3.4.1-r1 | 3.23.0 | Dec, 6th 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/120)) |
| 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 | :x: EOL | >= 3.4.1-r0 | 3.22.1 | † June, 1st 2026 ([eol notice](https://github.com/Burnett01/rsync-deployments/discussions/96)) |
| 7.0.2 | :x: EOL | >= 3.4.0-r0 | 3.22.1 | † June, 1st 2026 ([eol 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 | † |
### Terminology
@@ -26,6 +38,37 @@ EOL = End of life (no support/no updates)
DEPRECATED = Close to EOL (support/no updates)
ESU = Close to DEPRECATED (support/updates)
## Release cycles
Our aim is to follow the [Alpine Linux release cycles](https://alpinelinux.org/releases/).
Whenever a new Alpine version is released, we will release a new action version.
You can indicate the Alpine minor-version in our major-version number:
| Alpine Version | Action Version |
| ------- | ------------------ |
| 3.**24**.4 | **9**.0.4 |
| 3.**24**.3 | **9**.0.3 |
You can indicate the Alpine patch-version in our patch-version number:
| Alpine Version | Action Version |
| ------- | ------------------ |
| 3.24.**4** | 9.0.**4** |
| 3.24.**3** | 9.0.**3** |
If we release an OOB patch for a specific package update, our minor-version number increases:
| Alpine Version | Action Version |
| ------- | ------------------ |
| 3.24.4 | 9.**1**.4 |
| 3.24.3 | 9.**2**.3 |
**Note:** This is subject to change because we want to align our versioning with Alpines versioning.
## Reporting a Vulnerability
You can report a vulnerability by creating an issue.
+10 -2
View File
@@ -1,5 +1,5 @@
name: 'Rsync Deployments Action'
description: 'GitHub Action for deploying code via rsync over ssh'
description: 'GitHub Action for deploying code via rsync over ssh securely - used by 5k+ workflows!'
author: 'Burnett01'
inputs:
switches:
@@ -13,8 +13,12 @@ inputs:
description: 'Enables support for legacy RSA host keys on OpenSSH 8.8+'
required: false
default: 'false'
known_hosts:
description: 'Enables strict host keys checking against the hostkey you set.'
required: false
default: ''
strict_hostkeys_checking:
description: 'Controls strict host keys checking'
description: 'DEPRECATED: Controls strict host keys checking'
required: false
default: 'false'
path:
@@ -45,6 +49,10 @@ inputs:
description: 'Debug the action'
required: false
default: 'false'
log_level:
description: 'The log-level that is used in the rsh-switch'
required: false
default: 'ERROR'
runs:
using: 'docker'
image: 'Dockerfile'
+40
View File
@@ -0,0 +1,40 @@
# Scripts
Shell-scripts to help with managing SSH agents and known hosts files.
### SSH Management
#### ssh-init
This command create the ``$HOME/.ssh`` folder with default permissions ``700``.
### SSH-Agent Management
#### agent-start
This command starts the SSH agent, if it isn't already started (SSH_AGENT_PID set or ssh agent ID file found).
It takes one optional argument, for the name of the agent to be started. Defaults to "default".
This program needs to be source'd to work correctly.
`source agent-start "default"`
#### agent-stop
This command stops the SSH agent, if it is started (SSH_AGENT_PID set or ssh agent ID file found).
It takes one optional argument, for the name of the agent to be stopped. Defaults to "default".
`agent-stop "my-agent-name"`
#### agent-add
This command adds a key to the currently running SSH agent. The key is taken from stdin, and the agent used is that in SSH_AGENT_PID.
#### agent-askpass
This command is called by ssh-add when the [SSH_ASKPASS](https://man.openbsd.org/ssh-add.1#ENVIRONMENT) variable is set active. The command returns the SSH_PASS to [ssh-askpass(1)](https://man.openbsd.org/ssh-askpass.1).
This command is ignored by ssh-add if the key does not require a passphrase.
### known_hosts management
#### hosts-init
This command creates the known_hosts file (``$HOME/.ssh/known_hosts``) with default permission ``600``.
#### hosts-add
This command adds an entry to the known hosts file, and ensures its permissions are correct. It takes one argument, which is the new key to add.
#### hosts-clear
This command truncates the known_hosts file.
+1 -1
View File
@@ -2,4 +2,4 @@
set -eu
printf '%s\n' "$@" >> $HOME/.ssh/known_hosts
echo "$@" >> $HOME/.ssh/known_hosts
+4 -1
View File
@@ -2,5 +2,8 @@
set -eu
touch $HOME/.ssh/known_hosts
if [ ! -f "$HOME/.ssh/known_hosts" ]; then
touch $HOME/.ssh/known_hosts
fi
chmod 600 $HOME/.ssh/known_hosts
+3 -1
View File
@@ -2,4 +2,6 @@
set -eu
mkdir -m 700 $HOME/.ssh
if [ ! -d "$HOME/.ssh" ]; then
mkdir -m 700 $HOME/.ssh
fi
+34 -4
View File
@@ -2,8 +2,11 @@
set -eu
LOG_LEVEL="${INPUT_LOGLEVEL:-ERROR}"
if [ "${INPUT_DEBUG:-false}" = "true" ]; then
set -x
LOG_LEVEL=""
fi
if [ -z "$(echo "$INPUT_REMOTE_PATH" | awk '{$1=$1};1')" ]; then
@@ -17,7 +20,7 @@ source hosts-init
# Start the SSH agent and load key.
source agent-start "$GITHUB_ACTION"
printf '%s' "$INPUT_REMOTE_KEY" | SSH_PASS="${INPUT_REMOTE_KEY_PASS}" agent-add >/dev/null 2>&1
echo "$INPUT_REMOTE_KEY" | SSH_PASS="$INPUT_REMOTE_KEY_PASS" agent-add
# Variables.
LEGACY_RSA_HOSTKEYS=""
@@ -26,7 +29,11 @@ if [ "${INPUT_LEGACY_ALLOW_RSA_HOSTKEYS:-false}" = "true" ]; then
fi
STRICT_HOSTKEYS_CHECKING="-o StrictHostKeyChecking=no"
if [ "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}" = "true" ]; then
# If no 'known_hosts' input is provided and 'strict_hostkeys_checking: true',
# then use exisiting keyscan functionality. DEPRECATED: Will be no-op in next major.
if [[ -z "${INPUT_KNOWN_HOSTS:-}" && "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}" = "true" ]]; then
echo "::warning title=DEPRECATION::Input 'strict_hostkeys_checking' will be a no-op in the next major version! Use 'known_hosts'."
STRICT_HOSTKEYS_CHECKING="-o UserKnownHostsFile=$HOME/.ssh/known_hosts -o StrictHostKeyChecking=yes"
key="$(ssh-keyscan -p "$INPUT_REMOTE_PORT" "$INPUT_REMOTE_HOST" 2>/dev/null | sed '/^#/d')" || key=""
@@ -36,12 +43,35 @@ if [ "${INPUT_STRICT_HOSTKEYS_CHECKING:-false}" = "true" ]; then
# add to known hosts
echo "$key" | while IFS= read -r line; do hosts-add "$line"; done
else
echo "Warning: failed to fetch host key for $INPUT_REMOTE_HOST" >&2
echo "Warning: failed to fetch host key for remote host" >&2
exit 1
fi
# If 'known_hosts' is provided, strict hostkeys checking is auto enforced:
elif [ -n "${INPUT_KNOWN_HOSTS:-}" ]; then
STRICT_HOSTKEYS_CHECKING="-o UserKnownHostsFile=$HOME/.ssh/known_hosts -o StrictHostKeyChecking=yes"
if [ "$INPUT_REMOTE_PORT" = "22" ]; then
host_pattern="$INPUT_REMOTE_HOST"
else
host_pattern="[$INPUT_REMOTE_HOST]:$INPUT_REMOTE_PORT"
fi
printf '%s\n' "$INPUT_KNOWN_HOSTS" | tr -d '\r' | while IFS= read -r line; do
line="$(echo "$line" | awk '{$1=$1};1')"
case "$line" in
''|'#'*) continue ;;
ssh-*|ecdsa-*|sk-*) hosts-add "$host_pattern $line" ;;
*) hosts-add "$line" ;;
esac
done
if ! ssh-keygen -lf "$HOME/.ssh/known_hosts" >/dev/null 2>&1; then
echo "Error: Input 'known_hosts' contains no valid host key" >&2
exit 1
fi
fi
RSH="ssh $STRICT_HOSTKEYS_CHECKING $LEGACY_RSA_HOSTKEYS -p $INPUT_REMOTE_PORT $INPUT_RSH"
RSH="ssh $LOG_LEVEL $STRICT_HOSTKEYS_CHECKING $LEGACY_RSA_HOSTKEYS -p $INPUT_REMOTE_PORT $INPUT_RSH"
LOCAL_PATH="$GITHUB_WORKSPACE/$INPUT_PATH"
DSN="$INPUT_REMOTE_USER@$INPUT_REMOTE_HOST"