如何使用github进行自动化不停机CI/CD

前言#

最近在跟同学一起做一个产品，我们也没有什么钱，在做产品部署的时候想着能用免费的就用免费的了，于是就使用 github 完成了自动化 CI/CD 的蓝绿部署

思路#

蓝绿部署本质上就是两份文件，一份是新版本另一份是老版本，在切换版本时候不停机不影响另一份。而 github 又有 actions 可以免费做 CI/CD 的操作，那我们就可以通过 github 的 actions 来操作我们服务器了。

步骤#

github actions 脚本#

在 github 仓库跟根目录下准备 .github/workflows/test-deploy.yaml，其中test-deploy可以替换成你的部署的文件名，但是结尾必须是.yaml
我的 yaml 文件如下

1
name: 部署测试环境
2

3
on:
4
  push:
5
    branches:
6
      - develop # 或者是你想触发自动构建的分支
7
      - feat/**
8
    # 可以写也可以不写path模块，它的意思是当修改的代码命中下列规则时才会执行脚本
9
    paths:
10
      - "apps/server/**"
11
      - "apps/web/**"
12
      - ".github/workflows/test-delopy.yaml"
13
    # paths-ignore:
14
    #   - 'apps/mini-program/**'
15

16
# 公共的env 参考https://github.com/easingthemes/ssh-deploy下的tips
17
env:
18
  # 本地.ssh文件下的私钥id_rsa，存在secrets的PRIVATE_KEY中
19
  SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_PRIVATE_KEY_TEST }}
20
  # 服务器域名/IP
21
  REMOTE_HOST: ${{ secrets.SERVER_HOST_TEST }}
22
  # 服务器端口
23
  REMOTE_PORT: ${{ secrets.SERVER_PORT_TEST }}
24
  # 服务器默认用户名为root
25
  REMOTE_USER: ${{ secrets.SERVER_USER_TEST }}
26

27
jobs:
28
  test-deploy-server:
29
    runs-on: ubuntu-latest
30
    steps:
31
      - name: 检测仓库
32
        uses: actions/checkout@v3
33

34
      - name: 部署到服务器
35
        uses: appleboy/ssh-action@master
36
        with:
37
          host: ${{ env.REMOTE_HOST }}
38
          port: ${{ env.REMOTE_PORT }}
39
          username: ${{ env.REMOTE_USER }}
40
          key: ${{ env.SSH_PRIVATE_KEY }}
41
          script: |
42
            set -e  # 任何命令失败立即退出
43
            cd /home/apps/sports
44
            ./deploy-server.sh

上述的 yaml 文件表示当我的分支名命中develop或者是以feat开头时，并且我推送的代码的更改命中了 path 中声明的文件就会执行该 action，path 模块可以不写，不写的话表示只要命中了分支名就会执行该 action env 模块表示引用了 secret 中的变量到 env 中，方便后续再 steps 中使用，方便统一管理。我的 env 模块引用了四个变量，分别是服务器的ssh连接密钥、服务器地址、服务器ssh端口、服务器用户名，其中服务器指的是你的代码要部署的服务器。

下面的 jobs 模块声明了一个部署任务：test-deploy-server，该部署任务主要工作是使用了appleboy/ssh-action@master带服务器上执行 shell 脚本，我们上述声明的环境变量就是在此处使用的。比较重要的是部署到服务器步骤中的script中的内容，它表示：到服务器的 /home/apps/sports目录下执行deploy-server.sh脚本。

deploy-server.sh 脚本#

1
set -e  # 任何命令失败立即退出
2
# 加载了nvm的命令
3
source /root/.nvm/nvm.sh
4
# nvm使用了node24
5
nvm use 24
6
# 安装了pnpm
7
npm i -g pnpm
8
# 也可以设置执行当前脚本时的环境变量例如NODE_ENV
9
export NODE_ENV=production
10

11
# 目录定义
12
BLUE_DIR=/home/apps/sports/blue
13
GREEN_DIR=/home/apps/sports/green
14
CURRENT_SYMLINK=/home/apps/sports/current
15

16
# 自动创建目录（首次部署时不存在）
17
mkdir -p $BLUE_DIR
18
mkdir -p $GREEN_DIR
19

20
# 判断当前指向如果当前指向蓝则将当前指向为绿
21
if [ "$(readlink -f $CURRENT_SYMLINK)" == "$BLUE_DIR" ]; then
22
    NEW_DIR=$GREEN_DIR
23
else
24
    NEW_DIR=$BLUE_DIR
25
fi
26

27
echo "Deploying to $NEW_DIR ..."
28

29
# 清空新目录并拉取代码
30
rm -rf $NEW_DIR
31
mkdir -p $NEW_DIR
32
# 克隆当前的develop分支代码到新的文件夹中，当然也可以判断一下如果是首次就克隆后续可以直接pull
33
git clone -b develop git@github.com:zhaoyuqiqi/xxxx.git $NEW_DIR
34
cd $NEW_DIR
35
git checkout develop
36

37
# 安装依赖 & 构建
38
pnpm install
39

40
pnpm run build:server
41

42
# 数据库迁移
43
pnpm run migrate:server
44

45
# 更新 symlink
46
ln -sfn $NEW_DIR $CURRENT_SYMLINK
47

48
# PM2 reload(cluster 模式保证零停机)
49
cd /home/apps
50
# 通过机子上的PM2重新启动新项目
51
pm2 reload pm2.config.js --only sports
52

53
echo "Deployment completed successfully."

通过上述的步骤即可自动化部署一个零停机的 nodejs 应用，当然部署其他的也是类似的步骤，主要是通过了ln -sfn 地址A /home/apps/sports/current，将/home/apps/sports/current指向了地址 A，这个操作是瞬时的，并且在 pm2 的部署脚本中，部署的代码地址也是指向了/home/apps/sports/current所以可以做到切换当前目录后，直接重启 pm2 部署脚本即可。