diff --git a/Dockerfile b/Dockerfile index bb4a185..0fe5c56 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,9 @@ -FROM drinternet/rsync:v1.4.4 +# drinternet/rsync@v1.4.4 +FROM drinternet/rsync@sha256:15b2949838074bd93c49421c22380396a0cd53a322439e799ac87afcadcfe234 + +# always force-upgrade rsync to get the latest security fixes +RUN apk update && apk add --no-cache --upgrade rsync +RUN rm -rf /var/cache/apk/* # Copy entrypoint COPY entrypoint.sh /entrypoint.sh diff --git a/LICENSE b/LICENSE index 86b9855..3907af1 100644 --- a/LICENSE +++ b/LICENSE @@ -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 diff --git a/README.md b/README.md index eb393ec..fc7be23 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ Use this action in a CD workflow which leaves deployable code in `GITHUB_WORKSPA 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. +Alpine version: [3.19.1](https://alpinelinux.org/posts/Alpine-3.19.1-released.html) +Rsync version: [3.4.0-r0](https://download.samba.org/pub/rsync/NEWS#3.4.0) + --- ## Inputs @@ -40,11 +43,13 @@ 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.2 + ## Example usage Simple: -``` +```yml name: DEPLOY on: push: @@ -57,7 +62,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.0.0 + uses: burnett01/rsync-deployments@7.0.2 with: switches: -avzr --delete path: src/ @@ -69,14 +74,14 @@ jobs: Advanced: -``` +```yml jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.0.0 + uses: burnett01/rsync-deployments@7.0.2 with: switches: -avzr --delete --exclude="" --include="" --filter="" path: src/ @@ -89,14 +94,14 @@ jobs: 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@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.0.0 + uses: burnett01/rsync-deployments@7.0.2 with: switches: -avzr --delete path: src/ @@ -109,14 +114,14 @@ jobs: If your private key is passphrase protected you should use: -``` +```yml jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.0.0 + uses: burnett01/rsync-deployments@7.0.2 with: switches: -avzr --delete path: src/ @@ -135,14 +140,14 @@ jobs: 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"``. -``` +```yml jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: rsync deployments - uses: burnett01/rsync-deployments@7.0.0 + uses: burnett01/rsync-deployments@7.0.2 with: switches: -avzr --delete legacy_allow_rsa_hostkeys: "true" @@ -158,7 +163,16 @@ See [#49](https://github.com/Burnett01/rsync-deployments/issues/49) and [#24](ht --- -## Version 6.0 (MAINTENANCE) +## Version 7.0.0 & 7.0.1 (DEPRECATED) + +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) + +--- + +## Version 6.0 (EOL) Check here: @@ -166,7 +180,7 @@ Check here: --- -## Version 5.0, 5.1 & 5.2 & 5.x (DEPRECATED) +## Version 5.0, 5.1 & 5.2 & 5.x (EOL) Check here: @@ -225,28 +239,15 @@ 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/ - - https://elijahverdoorn.com/2020/04/14/automating-deployment-with-github-actions/ - https://www.vektor-inc.co.jp/post/github-actions-deploy/ -- https://ews.ink/tech/blog-deploy-2/ - - https://webpick.info/automatiser-avec-github-actions/ - https://matthias-andrasch.eu/blog/2021/tutorial-webseite-mittels-github-actions-deployment-zu-uberspace-uebertragen-rsync/ -- https://mikael.koutero.me/posts/hugo-github-actions-deploy-rsync/ - -- https://cdmana.com/2021/02/20210208122400688I.html - - https://jishuin.proginn.com/p/763bfbd38928 - https://cloud.tencent.com/developer/article/1786522 -- http://www.ningco.cn/github_action_deploy_blog/ - -- https://qdmana.com/2021/01/20210127094413405u.html diff --git a/SECURITY.md b/SECURITY.md index b85ce16..36f2e06 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,15 +4,17 @@ The following versions are currently being supported with security updates: -| Version | Supported | -| ------- | ------------------ | -| 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 | +| Version | Supported | Rsync version | +| ------- | ------------------ | ------------------ | +| 7.0.2 | :white_check_mark: | >= 3.4.0 | +| 7.0.1 | :warning: DEPRECATED | < 3.4.0 | +| 7.0.0 | :warning: DEPRECATED | < 3.4.0| +| 6.x | :x: EOL |< 3.4.0| +| 5.x | :x: EOL |< 3.4.0| +| 4.x | :x: EOL |< 3.4.0| +| 3.0 | :x: EOL |< 3.4.0| +| 2.0 | :x: EOL |< 3.4.0| +| 1.0 | :x: EOL |< 3.4.0| ## Reporting a Vulnerability