Github-CI 入门接入

背景

为了提高研发效率和代码质量,在代码分支合并前,需要使用CI(持续集成)能力对代码进行静态扫描、执行单元测试、代码构建、自动化测试、部署等操作。

技术方案

由于代码目前在Github托管,因此使用Github Action进行CI配置。本文对Github Action进行简要介绍。

概念

GitHub Actions 是一个持续集成和持续交付 (CI/CD) 平台,可以自动化的构建、测试和部署。这里简单介绍重要的概念,详情可参考官方文档

  • Workflow(工作流程) 是一个可配置的自动化过程,它将运行一个或多个Job(作业)。 Workflow由签入到存储库的 YAML 文件定义,并在存储库中的事件触发时运行。
  • Event (事件)是存储库中触发工作流程运行的特定活动。 比如提交代码时会触发Push事件。
  • Job(作业)是工作流程中的一组步骤,它们在同一运行器上执行。 每个步骤要么是将要执行的 shell 脚本,要么是将运行的操作 。 步骤按顺序执行,并且相互依赖。 由于每个步骤都在同一运行器上执行,因此您可以将数据从一个步骤共享到另一个步骤。
  • Action(操作)是 GitHub Actions 平台的自定义应用程序,用于执行复杂但经常重复的任务。 使用操作可帮助减少在工作流程文件中编写的重复代码量。
  • Runner(运行器)是当Workflow被触发时实际运行应用程序的服务器。每个运行器一次可以运行一个作业。 GitHub 提供 Ubuntu Linux、Microsoft Windows 和 macOS 运行器来运行您的工作流程。

简单总结上述的概念的关系

  • 一个Workflow可以定义一组事件进行触发
  • 一个Workflow由一个或者多个Job构成
  • 一个Job由多个Step构成,每个Step需要定义要执行的Action
  • 一个Job需要指定Action集合运行的服务器

Action复用

每个 Action 可以理解为一个独立脚本,因此可以做成代码仓库,使用actions/repoName的语法引用 action。比如,actions/checkout@v3就表示github.com/actions/checkout这个仓库,它代表一个 Action,这里的作用是拉取代码。

为了减少Action编写的重复量,Github官方绝妙的提供了Action官方市场,可以把通用的Action上传上去供大家直接引用。

因此面对特定的需求强烈建议先去官方市场搜索相关的Action,如果有好的Action当然也鼓励大家分享。

Runner评估

Runner是Action实际运行的环境,这里简要介绍下Github原生的Runner,详情可参考官方文档

  • 优点,简单快速使用,运维成本低
  • 缺点
    • 每次都重新初始化环境导致速度太慢
    • 机器资源不方便拓展
    • 与内网其他应用的交互受限,网络可能被限制
  • 应用场景:CI频次不高、集成场景不复杂、建议使用Github原生的Runner。

注意:如果对于Workflow有更高的要求,可能需要购买相关的升级服务,可参考计费详情

配置示例详解

经过以上的概念准备,现在以实际的Github CI配置进行描述。

Github CI配置是在仓库主目录下的.github/workflows/目录下的yaml文件,这里以创建Golang环境并执行单元测试为示例进行描述

name: learn-github-actions # Workflow名称
on: [push,pull_request] # 触发事件类型,这里是push和PR都会触发Workflow
jobs:
  check-bats-version: # Job名称
    runs-on: ubuntu-latest # 使用Github的ubuntu Runner,Job操作会在上面运行
    steps: # 操作集
      - uses: actions/checkout@v3 # 引用https://github.com/actions/checkout 脚本拉取代码
      - uses: actions/setup-go@v3 # 引用https://github.com/actions/setup-go 初始化go环境
        with:
          go-version: 1.14 # 设置引用Action的参数,这里要求Golang的版本是1.14
      - run: cd $GITHUB_WORKSPACE && go test # 切换到仓库主目录并执行单元测试,GITHUB_WORKSPACE变量由上述checkout提供

上述的配置文件生效后,在每次提交代码或者创建Pull Request时就会自动执行上述定义的所有Action,既拉取代码、安装Go环境、执行Go单元测试。

操作步骤

步骤 操作 描述 备注
1 创建github ci配置文件 在仓库主目录下创建目录.github/workflows/,并在其下创建xxx.yaml 也可以直接在仓库页面-> Actions->New workflow点击创建
2 修改github ci配置 按照上文“配置示例”配置ci执行的各步骤Action 触发事件参考文档,详细配置语法可参考文档
3 验证 提交Commit,验证事件是否触发,以及验证Job是否正常 具体执行结果可去仓库页面-> Actions查看

为了保证开源代码质量,Github众多开源代码都有CI接入配置,实际案例可参考etcd

总结

更多的拓展功能,快速参考链接如下

参考文档

https://github.com/marketplace?type=actions

https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions

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

推荐阅读更多精彩内容