使用github actions配置你的第一个CI/CD

github Actions

TL;DR

本文将从0到1，利用Github Actions配置出一套CI/CD

大体思路为，构建 docker image -> push docker image -> 访问远程主机 -> pull docker image -> run docker image

简介

简单来说，github Actions为github自己推出的一套 workflow，在repo首页点击该按钮可以进入。

image.png

通过workflow，你可以根据需要配置许多自定义的事件，例如每push完自动跑test，也例如本文要介绍的自动化CI/CD。

并且Github workflow支持许多hooks，包括不限于push，pull request，fork，issue，定时任务。大家可以发挥自己的想象力做很多有意思提高生产力的事情。

前期准备

这里用create-react-app 作为项目demo

npx create-react-app my-app
cd my-app
touch Dockerfile

经过上述3个命令，我们创建了一个React应用，并且建了一个Dockerfile文件

此时编辑Dockerfile

FROM node:12.16.1 
RUN yarn global add serve 
COPY yarn.lock package.json ./ 
RUN yarn COPY src src 
COPY public public 
RUN yarn build 
EXPOSE 4000 
CMD ["serve","build", "-p", "4000"]

Dockerfile命令很基础，大致意思就是

从node:12.16.1版本作为基础镜像

全局下载serve，主要用来起静态服务

执行yarn和build命令

最后用serve起一个4000的端口

这里CMD和RUN都是用来执行命令，区别之一在于RUN是在build image阶段执行，而CMD是在run container阶段执行的。

现在本地起run一下该image本地测试一下

docker build -t my-app .
docker run -p 4000:4000 -d my-app

此时浏览器打开localhost:4000应该成功看到一个React页面

github workflow编写

接来下就是要创建github workflow

cd my-app
touch .github/workflows/firstWorkflow.yml

值得注意的是workflow的编写是YAML语法，不熟悉的可以上网看一下文档，这里推荐阮一峰的文章(https://www.ruanyifeng.com/blog/2016/07/yaml.html)可以有个基础了解

name: Docker Image CI/ CD
env:
  DOCKER_REG: registry.cn-shanghai.aliyuncs.com/my-namespce/my-app
  REG: registry.cn-shanghai.aliyuncs.com
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

name：workflow的名字
env: 环境变量，由于我这里用的是阿里云的Docker registory，你也可以换成你需要的registory
on：表示了该workflow的触发时机，这里为当对master分支执行push或者pull request时触发

build

build部分大体就是build一个image，然后push到Docker Registory

jobs:
  build:
    runs-on: ubuntu-latest     
    steps:
    - uses: actions/checkout@v2
    - name: Login Docker
      run:
        echo "${{ secrets.PASSWORD }}" | docker login $REG -u "${{ secrets.USERNAME }}" --password-stdin
    - name: Build the Docker image
      run:
        docker build . --file Dockerfile --tag image
    - name: Push Image
      run: |
        # Strip git ref prefix from version
        VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
        # Strip "v" prefix from tag name
        [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
        # Use Docker `latest` tag convention
        [ "$VERSION" == "master" ] && VERSION=latest
        echo IMAGE_ID=$DOCKER_REG
        echo VERSION=$VERSION
        docker tag image $DOCKER_REG:$VERSION
        docker push $DOCKER_REG:$VERSION

runs-on: 表示该job运行的虚拟环境，目前内置支持的环境有Linux，MacOS，Windows，当然你也可以自己搭建

对于job，可以理解为一个workflow有若干个job组成，例如这里，会分成为build和接下来的deploy，通常来说job是并行的，也可以配置成串行。

steps: steps就是在job里执行命令或者action的task，一个jobs可以有多个steps

这里重点说一下action，action是workflow里可移植和共享的逻辑，可以理解为npm的package。访问action市场可以看到许多有意思有用的action

image.png

回到step的编写，这里使用的是最基础的action，即actions/checkout@v2，它的作用就是让我们的workflow可以访问到我们的repo。后续的name、run，就是给每一个执行命令定义了一个名字，这样我们在看job执行的时候，可以很方便的检出我们执行的哪一步出了什么问题。

${{ secrets.PASSWORD }} 这个语法需要注意一下，这是github workflow特有的语法，括号内部是表达式，其可以访问到workflow的上下文，例如secrets、github等。具体可以参考该链接

具体的执行步骤就大致为: 登录Docker -> build Docker -> tag Docker -> push Docker

deploy

deploy部分大体思路就是登连接到远程服务器，pull并启动刚刚build好的iamge

  deploy:
    runs-on: ubuntu-latest
    needs: build
    env:
      CONTAINER_NAME: my-app
    steps:
    - name: deploy docker image
      uses: appleboy/[email protected]
      with:
        host: ${{ secrets.HOST }}
        username: ${{ secrets.HOST_USERNAME }}
        password: ${{ secrets.HOST_PASSWORD }}
        envs: CONTAINER_NAME, DOCKER_REG
        script: |
          if [ $(docker ps -a | grep -c $CONTAINER_NAME) -gt 0 ]; then docker stop $CONTAINER_NAME;docker rm $CONTAINER_NAME;fi
          docker run --name $CONTAINER_NAME -d -p 4000:4000 $DOCKER_REG

needs: 之前提到job的执行默认是并行的，那么这里加上needs之后，会将job的执行变成串行，意思为当前该job的执行依赖build job。

我们这里使用了 appleboy/ssh-action action，主要用来帮助用ssh连接远程服务器，执行命令。

至此大致最简单的workflow就编辑完成了，提交该commit push之后，点击Action，就能看到当前workflow的执行情况了。

PS：本篇文章所有的命令都是为了演示demo，并不能直接将其用于生产环境。