如何通过GitHub推送事件触发带自定义环境变量的AWS CodePipeline？

前置准备 #

• 确保AWS账户已配置CodePipeline、CodeBuild的相关权限，且GitHub仓库已通过OAuth或访问令牌与AWS完成授权连接
• 梳理好需要传递的自定义环境变量（如VPS的SSH地址、部署脚本路径、应用目录等）

步骤1：为CodeBuild配置自定义环境变量 #

1. 进入AWS CodeBuild控制台，打开目标构建项目
2. 切换到环境配置页面，找到「环境变量」区域并点击编辑
3. 添加所需变量：
   • 变量名：例如VPS_SSH_HOST、VPS_DEPLOY_SCRIPT、APP_TARGET_PATH
   • 变量值：填入对应实际内容，敏感信息（如SSH密码）选择「加密」存储
4. 保存配置，确保CodeBuild构建过程可读取这些变量

步骤2：创建/配置CodePipeline流水线 #

1. 进入AWS CodePipeline控制台，新建或编辑流水线：
   • 源阶段：选择GitHub作为源提供商，关联目标仓库，设置触发条件为main分支的推送事件
   • 构建阶段：关联已配置好环境变量的CodeBuild项目
   • 部署阶段：针对带SSH权限的VPS，可选择两种实现方式：
     • 方式一：在CodeBuild的构建脚本中直接嵌入SSH部署逻辑，利用已配置的环境变量完成文件传输与脚本执行
     • 方式二：添加自定义部署动作，通过AWS Lambda或自定义脚本，借助环境变量传递VPS信息，执行SCP部署与服务重启
2. 保存流水线配置

步骤3：确认GitHub与AWS的触发联动 #

1. 若为新建流水线，在源阶段授权AWS访问目标仓库时，勾选「检测源变更时触发流水线」
2. 若为已有流水线，进入源阶段设置，确认触发事件为「推送至main分支」
3. 验证：向GitHub main分支推送代码，检查CodePipeline是否自动启动执行

步骤4：优化流水线匹配你的需求 #

• 一致性构建：CodeBuild使用统一的自定义构建镜像，避免本地构建的环境差异，确保每次构建结果一致
• 最小化停机时间：在部署脚本中加入滚动更新逻辑，比如先启动新应用实例、切换反向代理流量，再停止旧实例；或使用蓝绿部署模式
• 监控与维护：
  • 通过CodePipeline控制台查看各阶段执行日志，快速定位问题
  • 为CodeBuild、CodePipeline配置CloudWatch告警，异常时及时通知
  • 将CodeBuild的buildspec.yml、流水线配置说明存入GitHub仓库，便于版本管理与团队协作维护

关键配置示例 #

CodeBuild的buildspec.yml（含部署逻辑） #

version: 0.2
phases:
  build:
    commands:
      - npm install && npm run build # 替换为你的项目构建命令
      - echo "项目构建完成"
  post_build:
    commands:
      - # 用SSH连接VPS并执行部署脚本，使用配置好的环境变量
      - scp -o StrictHostKeyChecking=no -r ./dist/* $VPS_SSH_USER@$VPS_SSH_HOST:$APP_TARGET_PATH
      - ssh -o StrictHostKeyChecking=no $VPS_SSH_USER@$VPS_SSH_HOST "sh $VPS_DEPLOY_SCRIPT"
      - echo "部署完成"
artifacts:
  files:
    - '**/*'

注意事项 #

• 确保CodeBuild的执行角色拥有CloudWatch日志访问权限，以及读取AWS Secrets Manager（若存储敏感信息）的权限；同时需将VPS的SSH公钥添加到CodeBuild构建环境的信任列表
• 敏感环境变量优先存储在AWS Secrets Manager，而非明文填写

内容的提问来源于stack exchange，提问作者Naman Jain