mirror of
https://github.com/Burnett01/rsync-deployments.git
synced 2026-09-19 21:25:22 +08:00
Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 796cf0d5e4 | |||
| b2bc75ad2c | |||
| 93c0d7acae | |||
| 13aa4f9f57 | |||
| b16614048b | |||
| e1c5b900e9 | |||
| 93f02b856f | |||
| 21c0e5a9d9 | |||
| c88a1dbded | |||
| b9a68ac619 | |||
| f479c97783 | |||
| 008719532f | |||
| 9603fc8186 | |||
| 580c98fc2e | |||
| ee287eb1f0 | |||
| c04732dab2 | |||
| fb06973f0e | |||
| 45d84ad5f6 | |||
| d732b39732 | |||
| 570fd6bb52 | |||
| bef106d127 | |||
| d987a9a536 | |||
| a078b62820 | |||
| c7baefdc23 |
+2
-1
@@ -1,4 +1,5 @@
|
||||
FROM drinternet/rsync:v1.4.3
|
||||
# drinternet/rsync@v1.4.4
|
||||
FROM drinternet/rsync@sha256:15b2949838074bd93c49421c22380396a0cd53a322439e799ac87afcadcfe234
|
||||
|
||||
# Copy entrypoint
|
||||
COPY entrypoint.sh /entrypoint.sh
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019-2022 Contention
|
||||
Copyright (c) 2019-2022 Burnett01
|
||||
Copyright (c) 2019-2024 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
|
||||
|
||||
@@ -4,7 +4,7 @@ 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) of this action is very small and is based on Alpine 3.17.2 (no cache) which results in fast deployments.
|
||||
The base-image [drinternet/rsync](https://github.com/JoshPiper/rsync-docker/) of this action is very small and is based on Alpine 3.19.1 (no cache) which results in fast deployments.
|
||||
|
||||
---
|
||||
|
||||
@@ -14,6 +14,8 @@ The base-image (drinternet/rsync) of this action is very small and is based on A
|
||||
|
||||
- `rsh` - Remote shell commands
|
||||
|
||||
- `legacy_allow_rsa_hostkeys` - Enables support for legacy RSA host keys on OpenSSH 8.8+. ("true" / "false")
|
||||
|
||||
- `path` - The source path. Defaults to GITHUB_WORKSPACE and is relative to it
|
||||
|
||||
- `remote_path`* - The deployment target path
|
||||
@@ -38,6 +40,8 @@ This action needs secret variables for the ssh private key of your key pair. The
|
||||
|
||||
For simplicity, we are using `DEPLOY_*` as the secret variables throughout the examples.
|
||||
|
||||
## Current Version: 7.0.1
|
||||
|
||||
## Example usage
|
||||
|
||||
Simple:
|
||||
@@ -53,9 +57,9 @@ jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: rsync deployments
|
||||
uses: burnett01/rsync-deployments@5.2.2
|
||||
uses: burnett01/rsync-deployments@7.0.1
|
||||
with:
|
||||
switches: -avzr --delete
|
||||
path: src/
|
||||
@@ -72,9 +76,9 @@ jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: rsync deployments
|
||||
uses: burnett01/rsync-deployments@5.2.2
|
||||
uses: burnett01/rsync-deployments@7.0.1
|
||||
with:
|
||||
switches: -avzr --delete --exclude="" --include="" --filter=""
|
||||
path: src/
|
||||
@@ -92,9 +96,9 @@ jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: rsync deployments
|
||||
uses: burnett01/rsync-deployments@5.2.2
|
||||
uses: burnett01/rsync-deployments@7.0.1
|
||||
with:
|
||||
switches: -avzr --delete
|
||||
path: src/
|
||||
@@ -112,9 +116,9 @@ jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: rsync deployments
|
||||
uses: burnett01/rsync-deployments@5.2.2
|
||||
uses: burnett01/rsync-deployments@7.0.1
|
||||
with:
|
||||
switches: -avzr --delete
|
||||
path: src/
|
||||
@@ -125,9 +129,46 @@ jobs:
|
||||
remote_key: ${{ secrets.DEPLOY_KEY }}
|
||||
remote_key_pass: ${{ secrets.DEPLOY_KEY_PASS }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Version 5.0, 5.1 & 5.2
|
||||
#### 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"``.
|
||||
|
||||
```
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: rsync deployments
|
||||
uses: burnett01/rsync-deployments@7.0.1
|
||||
with:
|
||||
switches: -avzr --delete
|
||||
legacy_allow_rsa_hostkeys: "true"
|
||||
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 }}
|
||||
```
|
||||
|
||||
See [#49](https://github.com/Burnett01/rsync-deployments/issues/49) and [#24](https://github.com/Burnett01/rsync-deployments/issues/24) for more information.
|
||||
|
||||
---
|
||||
|
||||
## Version 6.0 (MAINTENANCE)
|
||||
|
||||
Check here:
|
||||
|
||||
- https://github.com/Burnett01/rsync-deployments/tree/6.0 (alpine 3.17.2)
|
||||
|
||||
---
|
||||
|
||||
## Version 5.0, 5.1 & 5.2 & 5.x (DEPRECATED)
|
||||
|
||||
Check here:
|
||||
|
||||
@@ -136,10 +177,10 @@ Check here:
|
||||
- https://github.com/Burnett01/rsync-deployments/tree/5.2 (alpine 3.15.0)
|
||||
- https://github.com/Burnett01/rsync-deployments/tree/5.2.1 (alpine 3.16.1)
|
||||
- https://github.com/Burnett01/rsync-deployments/tree/5.2.2 (alpine 3.17.2)
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
## Version 4.0 & 4.1
|
||||
## Version 4.0 & 4.1 (EOL)
|
||||
|
||||
Check here:
|
||||
|
||||
@@ -184,6 +225,8 @@ Please note that version 1.0 has reached end of life state.
|
||||
|
||||
This action was featured in multiple blogs across the globe:
|
||||
|
||||
> Disclaimer: The author & co-authors are not responsible for the content of the site-links below.
|
||||
|
||||
- https://leobrack.co.uk/blog/2020-02-15-automatically-push-changes-to-your-live-site-with-github-actions
|
||||
|
||||
- https://blog.maniak.co/ci-cd-for-wordpress/
|
||||
|
||||
+7
-6
@@ -6,12 +6,13 @@ The following versions are currently being supported with security updates:
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 5.x | :white_check_mark: |
|
||||
| 4.1 | :white_check_mark: |
|
||||
| 4.0 | :white_check_mark: |
|
||||
| 3.0 | :x: |
|
||||
| 2.0 | :x: |
|
||||
| 1.0 | :x: |
|
||||
| 7.x | :white_check_mark: |
|
||||
| 6.x | :information_source: MAINTENANCE |
|
||||
| 5.x | :warning: DEPRECATED |
|
||||
| 4.x | :x: EOL |
|
||||
| 3.0 | :x: EOL |
|
||||
| 2.0 | :x: EOL |
|
||||
| 1.0 | :x: EOL |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
|
||||
@@ -9,6 +9,10 @@ inputs:
|
||||
description: 'The remote shell argument'
|
||||
required: false
|
||||
default: ''
|
||||
legacy_allow_rsa_hostkeys:
|
||||
description: 'Enables support for legacy RSA host keys on OpenSSH 8.8+'
|
||||
required: false
|
||||
default: 'false'
|
||||
path:
|
||||
description: 'The local path'
|
||||
required: false
|
||||
|
||||
+9
-1
@@ -1,5 +1,10 @@
|
||||
#!/bin/sh
|
||||
|
||||
if [ -z "$(echo "$INPUT_REMOTE_PATH" | awk '{$1=$1};1')" ]; then
|
||||
echo "The remote_path can not be empty. see: github.com/Burnett01/rsync-deployments/issues/44"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Start the SSH agent and load key.
|
||||
source agent-start "$GITHUB_ACTION"
|
||||
echo "$INPUT_REMOTE_KEY" | SSH_PASS="$INPUT_REMOTE_KEY_PASS" agent-add
|
||||
@@ -8,8 +13,11 @@ echo "$INPUT_REMOTE_KEY" | SSH_PASS="$INPUT_REMOTE_KEY_PASS" agent-add
|
||||
set -eu
|
||||
|
||||
# Variables.
|
||||
LEGACY_RSA_HOSTKEYS="-o HostKeyAlgorithms=+ssh-rsa -o PubkeyAcceptedKeyTypes=+ssh-rsa"
|
||||
LEGACY_RSA_HOSTKEYS=$([ "$INPUT_LEGACY_ALLOW_RSA_HOSTKEYS" = "true" ] && echo "$LEGACY_RSA_HOSTKEYS" || echo "")
|
||||
|
||||
SWITCHES="$INPUT_SWITCHES"
|
||||
RSH="ssh -o StrictHostKeyChecking=no -p $INPUT_REMOTE_PORT $INPUT_RSH"
|
||||
RSH="ssh -o StrictHostKeyChecking=no $LEGACY_RSA_HOSTKEYS -p $INPUT_REMOTE_PORT $INPUT_RSH"
|
||||
LOCAL_PATH="$GITHUB_WORKSPACE/$INPUT_PATH"
|
||||
DSN="$INPUT_REMOTE_USER@$INPUT_REMOTE_HOST"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user