自动部署项目，全靠它了！

news2024/11/18 1:33:42

前几天我把我的开源项目部署到了云服务器。

我部署的大概流程：

登录到云服务器控制台，新建一个服务器实例（我用的 Ubuntu Linux）。
在自己的电脑上生成 SSH 秘钥，将生成的公钥和实例进行绑定。
使用 SSH 登录到云服务器，安装项目所需要的运行环境。
拉取代码，初始化依赖、编译、运行。
配置域名的 DNS 解析，修改 Nginx 配置。

然后就可以通过域名访问了。

这只是一个大概的流程，在实际操作的过程中可能会遇到很多问题。

这次主要分享的是如何利用 Github Actions 实现自动部署项目到云服务器。

最终的实现效果：

当我们的项目有新版本要发布时，我们直接把代码 push 到 Github 代码仓库，Github Actions 会自动帮我们把项目部署到云服务，也就是不需要我们手动登录到服务器进行拉取代码、初始化依赖、编译、运行等操作，我们只需要 push 一下代码，他就会自动把项目部署到云服务器。

很显然，Github Actions 可以为我们节省大量的部署项目的时间。

接下来，以我的开源项目为例，教你如何使用 Github Actions 部署项目到自己的云服务器。

开源项目地址：

https://github.com/zchengo/crm

首先，我们需要在云服务器上安装项目需要的运行环境，安装 Nginx 用于部署前端项目，安装 MySQL、Redis 用于为Go服务端提供数据库服务。同时，需要启动 Nginx、MySQL、Redis 服务，然后还需要编写一个Shell脚本用于重启Go服务端。

Github Actions 官方的定义：

在 GitHub Actions 的仓库中自动化、自定义和执行软件开发工作流程。您可以发现、创建和共享操作以执行您喜欢的任何作业（包括 CI/CD），并将操作合并到完全自定义的工作流程中。

Github Actions 的工作原理：

实际上就是Github官方给我们提供了一个虚拟机环境（如Windows、MacOS、Linux），项目安装、初始化依赖、打包编译全都是在这台虚拟机上操作的，再通过命令把最终打包生成的文件上传到云服务器，然后使用 ssh 在云服务器上执行一些命令，就完事了。

如何使用 Github Actions ？

1、我们需要在项目的根目录下创建.github/workflows/deploy.yaml，yaml文件的文件名可以自定义。

2、编写 deploy.yaml

name: CRM CI

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    
    - name: Use Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '18.12.0'    
        
    - name: Build Web
      run: cd web && npm install && npm run build  
    
    - name: Use Go
      uses: actions/setup-go@v3
      with:
        go-version: 1.19
    
    - name: Build Server
      run: cd server && go mod tidy && go build -o crmserver main.go
    
    - name: Deploy CRM
      env:
        KEY: ${{ secrets.SSH_PRIVATE_KEY }}
        HOST: ${{ secrets.REMOTE_HOST }}
      run: |
        mkdir -p ~/.ssh/ && echo "$KEY" > ~/.ssh/id_rsa && chmod 600 ~/.ssh/id_rsa
        scp -o StrictHostKeyChecking=no -r web/dist ubuntu@${HOST}:/usr/local/nginx/html/
        ssh -o StrictHostKeyChecking=no ubuntu@${HOST} "sudo /usr/local/nginx/sbin/nginx -s reload"
        scp -o StrictHostKeyChecking=no -r server/crmserver ubuntu@${HOST}:/home/ubuntu/
        ssh -o StrictHostKeyChecking=no ubuntu@${HOST} "sudo /home/ubuntu/crmapi/restart.sh > /dev/null 2>&1 &"

挺简单的，有几个地方需要说明一下。

env:
  KEY: ${{ secrets.SSH_PRIVATE_KEY }}
  HOST: ${{ secrets.REMOTE_HOST }}

SSH_PRIVATE_KEY 指的是你在自己电脑上生成的SSH私钥（这个私钥必须能连接到云服务器才行），REMOTE_HOST 指的是云服务器的IP地址，因为这两个变量属于敏感信息，所以需要在代码库->Settings->secrets->Actions 中设置，设置完成后，就可以通过 secrets 来调用。

mkdir -p ~/.ssh/ && echo "$KEY" > ~/.ssh/id_rsa && chmod 600~/.ssh/id_rsa

这个的作用就是让 Github 提供给我们的虚拟机能够连接到云服务器，所以我们需要把 ssh 私钥给虚拟机。

ssh -o StrictHostKeyChecking=no ubuntu@${HOST} "sudo /home/ubuntu/crmapi/restart.sh > /dev/null 2>&1 &"

这个就是在使用ssh执行云服务器上编写的脚本，用于重启服务端。/dev/null2>&1& 指的是把控制台（Go服务端运行）输出的内容输出到空设备，这样可以避免 Github Actions 一直处于运行状态。

/home/ubuntu/crmapi/restart.sh 脚本如下：

#!/bin/bash
sudo pkill crmserver
sudo cp /home/ubuntu/crmserver /home/ubuntu/crmapi/
sudo nohup /home/ubuntu/crmapi/crmserver > /home/ubuntu/crmapi/crmserver.log 2>&1 &