rtcamp/action-deploy-wordpress

Deploy WordPress - GitHub Action

此Action是https://github.com/rtCamp/创建的https://github.com/rtCamp/github-actions-library/的一部分，是一个基于https://deployer.org/通过GitHub Action将WordPress部署到服务器的工具。

请注意，此Action要求Git仓库结构符合特定规范：网站根目录应包含wp-content内的内容（uploads除外）。您可以使用https://github.com/rtCamp/wordpress-skeleton作为基础，或调整现有项目结构以适配。

部署过程中，默认情况下此Action会下载https://wordpress.org/latest.zip，将仓库内容放入`wp-content`目录，然后将整个WordPress设置部署到`hosts.yml`中指定的部署路径。`hosts.yml`是https://deployer.org/docs/hosts.html#inventory-file。

核心功能和特性

• 基于Deployer.org实现自动化部署流程
• 支持自定义WordPress版本及 minor 更新
• 可集成VIP MU插件或自定义MU插件仓库
• 支持通过跳转服务器部署
• 支持私有子模块的部署密钥配置
• 集成Hashicorp Vault管理SSH密钥
• 允许通过自定义deploy.php覆盖默认部署行为

使用场景和适用范围

适用于需要通过GitHub Actions自动化部署WordPress站点的场景，支持：

• 使用EasyEngine v4管理的新站点和现有站点
• 非EasyEngine环境的服务器配置
• 需要集中管理多服务器SSH密钥的场景
• 需自定义部署流程的复杂WordPress项目

使用方法和配置说明

基本使用步骤

1. 在GitHub仓库中创建.github/workflows/deploy.yml文件（若不存在）。

2. 向deploy.yml文件添加以下代码：

yml
on: push
name: 部署WordPress站点
jobs:
  deploy:
    name: 部署
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: 部署
      uses: rtCamp/action-deploy-wordpress@v2
      env:
        SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}

3. 使用https://developer.github.com/actions/creating-workflows/storing-secrets创建`SSH_PRIVATE_KEY`密钥，存储用于SSH连接`hosts.yml`中定义的服务器的私钥。

4. 基于https://deployer.org/docs/hosts.html#inventory-file格式创建`.github/hosts.yml` inventory文件。确保显式定义GitHub分支映射，只有hosts.yml中映射的分支会被部署，其余分支将被过滤。示例可参考https://github.com/rtCamp/wordpress-skeleton/blob/main/.github/hosts.yml。

环境变量

可通过以下环境变量自定义此GitHub Action的行为：

服务器设置

Deployer.org要求服务器按特定方式配置。

使用EasyEngine v4

新站点

1. 创建站点时传递标志--public-dir=current。
2. 使用rm -r /opt/easyengine/sites/example.com/app/htdocs/current删除current文件夹。

current文件夹将在Deployer执行期间自动创建。

现有站点

1. 打开文件/opt/easyengine/sites/example.com/config/nginx/conf.d/main.conf。
2. 将/var/www/htdocs替换为/var/www/htdocs/current。
3. 运行ee site reload example.com。
4. 将wp-config.php移动到htdocs，可使用以下命令：

bash
mv /opt/easyengine/sites/example.com/app/wp-config.php /opt/easyengine/sites/example.com/app/htdocs/wp-config.php

不使用EasyEngine

1. 确保Web服务器指向原始网站根目录内的current子目录，且current子目录实际不存在。
2. 可能需要重新加载Web服务器。
3. 可能需要按上述部分调整wp-config.php的位置。

Hashicorp Vault（可选）

此GitHub Action支持https://www.vaultproject.io/，便于管理多服务器时避免为每个项目单独配置`SSH_PRIVATE_KEY`作为GitHub密钥。

要启用Hashicorp Vault支持，需定义以下GitHub密钥：

需将deploy.yml文件中的secrets行修改为：

yml
on: push
name: 使用vault部署WordPress站点
jobs:
  deploy:
    name: 部署
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: 部署
      uses: rtCamp/action-deploy-wordpress@v2
      env:
        VAULT_ADDR: ${{ secrets.VAULT_ADDR }}
        VAULT_TOKEN: ${{ secrets.VAULT_TOKEN }}

GitHub Action使用VAULT_TOKEN连接VAULT_ADDR以获取https://www.vaultproject.io/docs/secrets/ssh/signed-ssh-certificates.html#signing-key-amp-role-configuration并用于部署。

需预先配置每个目标部署服务器接受通过Vault签名的SSH证书连接，通常需在每台服务器上运行以下命令一次：

bash
export VAULT_ADDR='https://example.com:8200'
export VAULT_TOKEN='s.gIX5MKov9TUp7iiIqhrP1HgN'

# 将公钥添加到所有目标主机的SSH配置
curl -o /etc/ssh/trusted-user-ca-keys.pem "$VAULT_ADDR/v1/ssh-client-signer/public_key"

# 将公钥内容存储路径添加到SSH配置文件作为TrustedUserCAKeys选项
echo "TrustedUserCAKeys /etc/ssh/trusted-user-ca-keys.pem" >> /etc/ssh/sshd_config

# 重启SSH服务（可能因操作系统而异）
systemctl restart ssh

覆盖默认部署行为

在Git仓库中创建.github/deploy/deploy.php文件，可提供自定义的https://deployer.org/脚本。

请注意，这将完全覆盖此Action的https://github.com/rtCamp/action-deploy-wordpress/blob/master/deploy.php。若需要保留原始`deploy.php`的部分内容，需将其复制到自定义的`.github/deploy/deploy.php`中。

许可证

MIT © 2021 rtCamp