阅读 95

手把手带你实践前端CI/CD(github action+docker)

随着前端技术的日益发展,现在的前端工程师已不仅仅局限于代码、功能的实现,也随着业务体积的变大,进行形成了对前端工程化的要求。在这个时间就是金钱的互联网的时代,效率就显得非常重要了,所以在工程化中的一环CI/CD就成为了现代前端工程师需要掌握的一项技能。

本篇文章就主要以实践来让你快速的入手一个CI/CD的流程,下面简单的介绍一下CI/CD的定义,其他的就不过多赘述了,github action和docker相关的东西这里也不进行深入的介绍了,有兴趣的或者不懂的可以自行查阅资料,或者笔者后面可以补充文章进行介绍。

一、CI/CD的定义

CI/CD简单的理解就是把我们以前工作中的开发上线步骤以自动化的形式去执行。

1、CI和CD值之间的区别和联系

  • CI就是持续集成(Continuous Integration):当代码仓库代码发生变更,就会自动对代码进行测试和构建,反馈运行结果。

  • CD就是持续交付(Continuous Delivery):持续交付是在持续集成的基础上,可以将集成后的代码依次部署到测试环境、予发布环境、生产环境等中

二、创建项目

这里以react脚手架创建项目为例

1、创建项目

create-react-app demo
复制代码

image.png

2、打包项目

yarn build
复制代码

三、连接服务器

ssh root@xx.xx.xx.xx # your server ip
复制代码

四、安装docker

1、安装需要的安装包

# 查看是否安装了docker
yum list installed | grep docker

yum install -y yum-utils device-mapper-persistent-data lvm2
复制代码

2、设置镜像的仓库

  • 默认镜像(国外的)

    yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
    复制代码
  • 阿里云的镜像(推荐)

    yum-config-manager --add-repo http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo
    复制代码

3、更新yum软件包的索引

yum makecache fast

yum makecache  #centos8
复制代码

4、安装docker docker-ce社区版 ee是企业版

yum install docker-ce docker-ce-cli  containerd.io
复制代码

5、启动docker

systemctl start docker
复制代码

6、测试

docker run hello-world
复制代码

7、查看docker服务状态

image-20211014213935697.png

五、基于docker安装nginx

1、查看docker已有的images(镜像)

docker images
复制代码

image-20211015203159825.png

2、查询需要下载的nginx镜像

docker search nginx
复制代码

image-20211015203406242.png

3、拉取nginx镜像

docker pull nginx
复制代码

image-20211015203610786.png

4、查看是否拉取成功

docker images
复制代码

image-20211015203736477.png

5、启动镜像

  • -d:表示在后台运行
  • -p:端口映射 冒号前是本机端口,冒号后是容器端口
  • --name=镜像名称 最后的nginx是创建的nginx镜像
docker run -d -p 8080:80 --name=iamgeName nginx
复制代码

6、查看是否可以访问

输入服务器公网ip:8080,如果看到了以下界面就说明nginx已经安装成功了

image-20211015205526089.png

7、如果没有看到这个界面,可能是购买的云服务器没有配置端口,下面以腾讯云为例,讲一下怎么配置

  • 找到防火墙,然后点击添加规则,应用类型选择自定义

image-20211015210126450.png image-20211015210205582.png image-20211015205502215.png

  • 然后再访问服务器公网ip:8080

六、配置github action

方案一:结合镜像容器服务托管镜像实现

1、配置容器镜像服务

这里我选择的是阿里云的容器镜像服务

a. 创建实例

个人版免费,基本够用,运用于线上项目需要使用企业版

image-20211018202903774.png

b. 设置登录密码

image-20211018203057845.png

c. 创建镜像仓库

  • 创建命名空间

  • 创建镜像仓库

  • 配置源代码

    • 我选择了本地仓库

      • 为了日志统一,可以在 Github Actions 看到所有日志,
      • 可以通过命令行直接推送镜像到镜像仓库,自由度比较高

image-20211018204427051.png

d. 查看镜像仓库

点击仓库名称可以看到仓库的一些基本信息和操作指南

image-20211018204921955.png

2、在项目根目录下创建nginx.conf文件

server {
  listen 80;
  server_name localhost;

  location / {
    root  /usr/share/nginx/html;
    index index.html index.htm;
    proxy_set_header Host $host;
    if (!-f $request_filename) {
      rewrite ^.*$ /index.html break;
    }
  }
  error_page 500 502 503 504 /50x.html;

  location = /50x.html {
    root /usr/share/nginx/html;
  }
}
复制代码

3、在项目根目录下创建Dockerfile文件

# 指定基础镜像,必须为第一个命令
FROM nginx
# 复制构建文件到容器中
COPY ./dist/ /usr/share/nginx/html/
# 复制nginx配置到容器中
COPY ./nginx.conf /etc/nginx/conf.d/react-demo.conf
# 指定端口
EXPOSE 80
复制代码

4、在项目根目录下创建dockerBootstrap.sh文件

echo -e "---------登录镜像容器服务--------"
# 登录阿里云镜像容器服务
docker login --username=$1 registry.cn-hangzhou.aliyuncs.com --password=$2
echo -e "---------停掉镜像--------"
# 停掉容器
docker stop react-demo
echo -e "---------删除本地容器和镜像--------"
# 删除本地容器
docker rm react-demo
# 删除本地镜像
docker rmi registry.cn-hangzhou.aliyuncs.com/yusongh/react-demo:latest
echo -e "---------拉取镜像--------"
# 拉取镜像
docker pull registry.cn-hangzhou.aliyuncs.com/yusongh/react-demo:latest
echo -e "---------创建容器并运行容器--------"
# -rm: docker会在容器退出时删除与它关联的数据卷
# -d: 后台运行容器,并返回容器ID
# -p: 端口映射,本机端口:容器端口
# --name: 指定容器名称
# 最后一个为镜像名称
docker run --rm -d -p 8080:80 --name react-demo registry.cn-hangzhou.aliyuncs.com/yusongh/react-demo:latest
echo -e "---------执行完毕--------"
复制代码

5、在项目下创建.github/workflows/test.yml文件

name: Docker Image CI # Actions名称

on: # 执行时机
  push:
    branches:
      - master

jobs:
  build:
    # runs-on 指定job任务运行所需要的虚拟机环境(必填字段)
    runs-on: ubuntu-latest
    steps:
      # 拉取代码
      - name: checkout # 步骤名字
        # 使用action库  actions/checkout拉取源码
        uses: actions/checkout@master

      # 安装依赖
      - name: install
        run: npm install

      # 打包
      - name: build project
        run: npm run build
        
      # 登录阿里云镜像容器服务,打包镜像,推送镜像
      - name: Build the Docker image
        run: |
          # 登录阿里云镜像容器服务
          docker login --username=${{ secrets.DOCKER_USERNAME }} registry.cn-hangzhou.aliyuncs.com --password=${{ secrets.DOCKER_PASSWORD }}
          # 使用当前目录的 Dockerfile 创建镜像,标签为 react-demo:latest
          docker build -t react-demo:latest . 
          # 打标签
          docker tag react-demo registry.cn-hangzhou.aliyuncs.com/yusongh/react-demo:latest
          # 推送到阿里云镜像容器服务
          docker push registry.cn-hangzhou.aliyuncs.com/yusongh/react-demo:latest
      # 登录服务器执行脚本
      - name: ssh docker login
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ${{ secrets.SSH_USERNAME }}
          password: ${{ secrets.SSH_PASSWORD }}
          script: cd /home/react-demo/ && sh react-demo.sh ${{ secrets.DOCKER_USERNAME }} ${{ secrets.DOCKER_PASSWORD }}
复制代码

6、配置Actions secrets

image.png

完成以上步骤,当提交代码到master分支时,就会触发github action的workflow。自动拉取代码,构建镜像到镜像容器服务,并登录服务器拉取镜像启动镜像。

方案二:映射服务器本机目录到容器

该方案省去了构建镜像到镜像服务,拉取打包代码后,直接覆盖服务器指定目录,该目录映射到容器中实现修改容器内资源

1、映射本机目录到容器目录

解释一下标题 如果我们想修改nginx的配置,想更改nginx中的资源文件怎么办?就是将容器中的目录和本机目录做映射,以达到修改本机目录文件就影响到容器中的文件。

1、本机创建文件夹

  • 大致目录
/home
    |---yusong
           |----nginx
                  |----conf.d
                  |----html
复制代码

2、在conf.d文件夹下新建default.conf文件

server {
    listen       80;
    server_name  localhost;
    # 原来的配置,匹配根路径
    #location / {
    #    root   /usr/share/nginx/html;
    #    index  index.html index.htm;
    #}
    # 更该配置,匹配/路径,修改index.html的名字,用于区分该配置文件替换了容器中的配置文件
    location / {
        root   /usr/share/nginx/html;
        index  index-test.html index.htm;
    }
}
复制代码

3、在html中编写index-test.html,用以判断文件夹映射成功

<html>
  <body>
    <h1>this is homePage</h2>
  </body>
</html>
复制代码

4、启动nginx(8080),映射路径

docker run -d -p 8080:80 -v /home/panwei/nginx/conf.d:/etc/nginx/conf.d  -v /home/panwei/nginx/html:/usr/share/nginx/html nginx
复制代码

-v,-v的意思就是冒号前面代表本机路径,冒号后面代表容器内的路径,两个路径进行了映射,本机路径中的文件会覆盖容器内的文件。 nginx容器内的一些文件位置: 日志位置:/var/log/nginx/ 配置文件位置:/etc/nginx/ 项目位置:/usr/share/nginx/html

七、访问服务器ip:8080

看到了打包的页面表示成功了

八、参考文章

  1. 手把手教你用 Github Actions 部署前端项目
文章分类
前端
文章标签