使用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<https://github.com/marketplace?type=actions>

image.png

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

${{ secrets.PASSWORD }} 这个语法需要注意一下,这是github workflow特有的语法,括号内部是表达式,其可以访问到workflow的上下文,例如secrets、github等。具体可以参考该链接<https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions>

具体的执行步骤就大致为: 登录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/ssh-action@v0.0.7
      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,并不能直接将其用于生产环境。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,590评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,808评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,151评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,779评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,773评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,656评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,022评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,678评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,038评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,756评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,411评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,005评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,973评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,053评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,495评论 2 343

推荐阅读更多精彩内容