rsync 部署

这个 GitHub Action（amd64）通过 ssh 使用 rsync 将 GITHUB_WORKSPACE 中的文件部署到远程文件夹。

在 CD 工作流中使用此 action，该工作流会在 GITHUB_WORKSPACE 中留下可部署的代码。

此 action 的基础镜像 drinternet/rsync 非常小，基于 Alpine 3.19.1（无缓存），可实现快速部署。

输入

switches* - 用于任何初始/必需的 rsync 标志，例如：-avzr --delete
rsh - 远程 shell 命令
legacy_allow_rsa_hostkeys - 在 OpenSSH 8.8+ 上启用对旧版 RSA 主机密钥的支持。（"true" / "false"）
path - 源路径。默认为 GITHUB_WORKSPACE 并相对于它
remote_path* - 部署目标路径
remote_host* - 远程主机
remote_port - 远程端口。默认为 22
remote_user* - 远程用户
remote_key* - 远程 ssh 密钥
remote_key_pass - 远程 ssh 密钥密码（如果有）

* = 必需

必需的密钥

此 action 需要 ssh 密钥对的私钥作为密钥变量。公钥部分应添加到接收部署的服务器上的 authorized_keys 文件中。密钥变量应在组织/仓库的 Github secrets 部分设置，然后作为 remote_key 输入引用。

处理敏感输入时始终使用密钥！

为简单起见，我们在示例中使用 DEPLOY_* 作为密钥变量。

当前版本：7.0.1

使用示例

简单：

name: DEPLOY
on:
  push:
    branches:
    - master

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
        path: src/
        remote_path: /var/www/html/
        remote_host: example.com
        remote_user: debian
        remote_key: ${{ secrets.DEPLOY_KEY }}

高级：

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 --exclude="" --include="" --filter=""
        path: src/
        remote_path: /var/www/html/
        remote_host: example.com
        remote_port: 5555
        remote_user: debian
        remote_key: ${{ secrets.DEPLOY_KEY }}

为了更好的安全性，我建议您为 remote_host、remote_port、remote_user 和 remote_path 输入创建额外的密钥。

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
        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 }}

如果您的私钥受密码保护，您应该使用：

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
        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 }}
        remote_key_pass: ${{ secrets.DEPLOY_KEY_PASS }}

对 OpenSSH 服务器 >= 8.8+ 的旧版 RSA 主机密钥支持

如果您的远程 OpenSSH 服务器仍在使用 RSA 主机密钥，则您必须通过使用 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 }}

有关更多信息，请参阅 #49 和 #24。