wpengine/gha

WP Engine GitHub Action 站点部署

使用此GitHub Action可将代码从GitHub仓库部署到指定的WP Engine环境。如果您还没有WP Engine账户，点击此处开始使用。

核心功能和特性

• 部署完整站点目录或WordPress安装的子目录
• 执行PHP代码检查（PHP Lint）
• 自定义rsync传输标志
• 清除缓存
• 执行自定义部署后脚本

使用场景和适用范围

适用于需要将WordPress站点代码从GitHub仓库自动化部署到WP Engine环境的开发者和团队。支持多分支对应多环境的部署策略，可根据不同分支配置不同的部署流程（如生产环境、 staging环境等）。

详细使用方法和配置说明

准备步骤

1. 在WP Engine中设置SSH公钥

• 如果尚未生成SSH密钥对，请生成新的SSH密钥对。注意：此SSH密钥必须是无密码的。
• 将SSH公钥添加到WP Engine SSH网关密钥设置中，参考指南。

2. 在GitHub中设置SSH私钥

• 将SSH私钥添加到https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository%E6%88%96https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-organization%E4%B8%AD%E3%80%82%E5%B0%86%E6%96%B0%E5%AF%86%E9%92%A5%E7%9A%84%E2%80%9C%E5%90%8D%E7%A7%B0%E2%80%9D%E4%BF%9D%E5%AD%98%E4%B8%BA%60WPE_SSHG_KEY_PRIVATE%60%E3%80%82

3. YML文件设置

• 在本地创建.github/workflows/main.yml目录和文件。
• 复制以下配置并替换branches:和WPE_ENV:的值。
• 如需从其他分支部署，可为该分支创建另一个yml文件（如.github/workflows/stage.yml），并修改branches:和WPE_ENV:的值以适应对应环境。

此配置支持为不同分支/环境设置不同的部署流程。有关更多可用选项，请参考“环境变量和密钥”部分。

4. 推送代码

将站点代码推送到GitHub仓库，Action将自动执行部署流程。可通过仓库的“Actions”选项卡查看部署进度和日志。

GitHub Action工作流示例

简单main.yml配置：

yml
name: 部署到WP Engine
on:
  push:
    branches:
     - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: GitHub Action部署到WP Engine
      uses: wpengine/github-action-wpe-site-deploy@v3
      with:
        WPE_SSHG_KEY_PRIVATE: ${{ secrets.WPE_SSHG_KEY_PRIVATE }}
        WPE_ENV: <your_install_name_here>

扩展main.yml配置：

yml
name: 部署到WP Engine
on:
  push:
    branches:
     - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: GitHub Action部署到WP Engine
      uses: wpengine/github-action-wpe-site-deploy@v3
      with:
      # 部署变量
        WPE_SSHG_KEY_PRIVATE: ${{ secrets.WPE_SSHG_KEY_PRIVATE }}
        WPE_ENV: <your_install_name_here>
        # 部署选项
        SRC_PATH: "wp-content/themes/genesis-child-theme/"
        REMOTE_PATH: "wp-content/themes/genesis-child-theme/"
        PHP_LINT: TRUE
        FLAGS: -azvr --inplace --delete --exclude=".*"  --exclude=wp-content/mu-plugins/local-plugin --exclude-from=ignorefile.txt
        SCRIPT: "path/yourscript.sh"
        CACHE_CLEAR: TRUE

环境变量和密钥

必填项

部署选项

补充说明

• 注意：此Action不使用WP Engine GitPush或此处的GitPush SSH密钥。
• 提示：如果使用GitHub组织，将SSH密钥添加到https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-organization%E5%90%8E%EF%BC%8C%E6%89%80%E6%9C%89%E4%BB%93%E5%BA%93%E5%8F%AF%E9%80%9A%E8%BF%87%E7%A4%BA%E4%BE%8B%60main.yml%60%E4%B8%AD%E7%9A%84%E6%96%B9%E6%B3%95%E5%BC%95%E7%94%A8%E5%90%8C%E4%B8%80SSH%E5%AF%86%E9%92%A5%E8%BF%9B%E8%A1%8C%E9%83%A8%E7%BD%B2%E3%80%82%E8%AF%A5SSH%E5%AF%86%E9%92%A5%E8%BF%98%E5%8F%AF%E8%BF%9E%E6%8E%A5%E5%88%B0%E5%85%B6WP Engine用户有权访问的所有安装，因此一个密钥可用于将所有项目部署到WP Engine上的各自站点，减少工作量。
• https://docs.github.com/en/actions/reference/environment-variables
• https://docs.github.com/en/actions/reference/encrypted-secrets
• 建议使用WP Engine的.gitignore模板之一。
• 此Action默认排除若干文件和目录，可参考https://github.com/wpengine/github-action-wpe-site-deploy/blob/main/exclude.txt%E3%80%82

版本控制

我们遵循SemVer和https://github.com/actions/toolkit/blob/01e1ff7bc04e1c57c980a0d***a5b60cf812/docs/action-versioning.md%E6%9D%A5%E7%BB%B4%E6%8A%A4%E4%B8%BB%E8%A6%81%E3%80%81%E6%AC%A1%E8%A6%81%E5%92%8C%E8%A1%A5%E4%B8%81https://github.com/wpengine/github-action-wpe-site-deploy/tags%E3%80%82%E8%A1%A5%E4%B8%81%E6%A0%87%E7%AD%BE%EF%BC%88%E5%A6%82%60v1.1.1%60%EF%BC%89%E4%B8%BA%E6%AF%8F%E4%B8%AA%E5%8F%91%E5%B8%83%E5%88%9B%E5%BB%BA%EF%BC%8C%E5%88%9B%E5%BB%BA%E5%90%8E%E4%B8%8D%E4%BC%9A%E5%8F%98%E6%9B%B4%E3%80%82%E4%B8%BB%E8%A6%81%E6%A0%87%E7%AD%BE%EF%BC%88%E5%A6%82%60v1%60%EF%BC%89%E5%92%8C%E6%AC%A1%E8%A6%81%E6%A0%87%E7%AD%BE%EF%BC%88%E5%A6%82%60v1.1%60%EF%BC%89%E5%B0%86%E6%9B%B4%E6%96%B0%E4%BB%A5%E8%B7%9F%E8%B8%AA%E5%90%84%E8%87%AA%E7%9A%84%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E3%80%82

建议将此Action绑定到最新的主要标签，以接收向后兼容的更新。