2020-07-09 14:01:58

初体验 GitHub Actions Workflows 工作流入门教程以及我的使用感受


初体验 GitHub Actions Workflows 工作流入门教程以及我的使用感受

GitHub Actions 是 GitHub 于2018年10月推出的持续集成服务。之前我使用的是Travis CI,昨天我体验了一次GitHub Actions,感觉功能更强大,可以玩的地方更多,我就介绍一下我初次使用的感受。

GitHub Actions 是什么

GitHub Actions 可以参考的同类对象有Jenkins、Azure Pelines、CircleCI、TravisCI等,都是持续集成(Continuous integration,简称CI)服务的提供商,持续集成其实说白了就是根据每次提交的变化不停的在设计、开发、测试、发布这样滚动:

而持续集成的流程是由很多步奏组成的,例如先构建准备运行环境、从Git指定分支拉取代码、编译打包、运行单元测试、登陆远程服务器、发布到第三方等等步奏,GitHub把这些动作都称之为Action,所以由多个Action构成的工作流就被命名为 GitHub Actions。

为了能让Actions能够复用,GitHub还提供了官方市场,可以搜索其他人提交的Action脚本,还有其他人收集的Action仓库:awesome actions

GitHub Actions 官方市场

GitHub Actions 的构成

GitHub Actions 是由下面几部分组成的:

  • workflow (工作流程):持续集成一次运行的过程,就是一个 workflow。
  • job (任务):一个 workflow 由一个或多个 jobs 构成,含义是一次持续集成的运行,可以完成多个任务。
  • step(步骤):每个 job 由多个 step 构成,一步步完成。
  • action (动作):每个 step 可以依次执行一个或多个命令(action)。

GitHub Actions 工作流文件

想要配置 GitHub Actions 的工作流,我们只需要定义一个YAML文件即可,它存放在代码仓库的.github/workflows目录,例如我的工作流文件:https://github.com/renfei-net/WinterEE/blob/513214d5e7288cee65721c9d05aebdff18d60a04/.github/workflows/build.yml,文件的名字可以自己定义,没有要求。workflow 的语法字段非常多,可以参见官方文档。下面是我自己写的工作流文件:

name: build
on: [push, pull_request]
jobs:
  build:
    name: building
    runs-on: ubuntu-latest
    services:
      mysql:
        image: mysql:5.7
        ports:
          - 3306:3306
        env:
          MYSQL_ALLOW_EMPTY_PASSWORD: yes
          MYSQL_DATABASE: winteree
          MYSQL_ROOT_PASSWORD: root
        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
      rabbitmq:
        image: rabbitmq:3.7.26-management-alpine
        ports:
          - 15672:15672
          - 5672:5672
      zipkin:
        image: openzipkin/zipkin:2.21.1
        ports:
          - 9411:9411
      redis:
        image: redis:6.0.1
        ports:
          - 6379:6379
    steps:
      - uses: actions/checkout@v2
      - name: Set up JDK 1.8
        uses: actions/setup-java@v1
        with:
          java-version: 1.8
      - name: Verify MariaDB Connection and Load Data
        env:
          PORT: ${{ job.services.mysql.ports[3306] }}
        run: |
          while ! mysqladmin ping -h"127.0.0.1" -P"$PORT" --silent; do
            sleep 1
          done
      - name: Loading Database
        env:
          PORT: ${{ job.services.mysql.ports[3306] }}
        run: mysql -h 127.0.0.1 -P $PORT -uroot -proot --default-character-set=utf8 winteree < environment/db/winteree.sql
      - name: Cache Maven packages
        uses: actions/cache@v2
        with:
          path: ~/.m2
          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
          restore-keys: ${{ runner.os }}-m2
      - name: Build with Maven
        run: mvn -B clean package --file pom.xml
      - name: Upload Coveralls
        shell: bash
        run: |
          curl -s https://codecov.io/bash
          mvn clean test org.jacoco:jacoco-maven-plugin:prepare-agent install org.jacoco:jacoco-maven-plugin:report
          mvn org.eluder.coveralls:coveralls-maven-plugin:report -DrepoToken="${{ secrets.coveralls_token }}"
  • name:是我给这个工作流起的名字,你可以起一个属于你的名字,这个没有要求。
  • on:是指定触发 workflow 的条件,通常是某些事件,我这里定义了push和pull_request事件就会触发这个工作流。
  • jobs:是workflow 文件的主体,表示要执行的一项或多项任务。
  • jobs.build:是我自己给这个任务起的ID叫”build“,下面我使用<job_id>来代替这个任务ID,你可以给你的任务起一个你自己的任务ID。
  • jobs.<job_id>.name:是我自己给这个任务起的名字叫”building“,你可以给你的任务起一个你自己的任务名称。
  • jobs.<job_id>.runs-on:是指定运行所需要的虚拟机环境。它是必填字段。目前可用的虚拟机有:ubuntu、windows、macOS。
  • jobs.<job_id>.services:是声明运行环境所需要的服务,我这里使用了MySQL、RabbitMQ、Zipkin、Redis。
  • jobs.<job_id>.steps:指定每个 Job 的运行步骤,可以包含一个或多个步骤。
  • jobs.<job_id>.steps.name:指这个不步奏的名称。
  • jobs.<job_id>.steps.run:指该步骤运行的命令或者 action。
  • jobs.<job_id>.steps.env:指该步骤所需的环境变量。

GitHub Actions 中使用密码

密码是不应该公开在代码仓库里的,所以需要先到项目仓库的 Settings -> Secrets 中添加你的密码,例如我添加了名为”COVERALLS_TOKEN“的密码:

GitHub Actions 密码设置

然后在workflow流程文件中使用”${{ secrets.coveralls_token }}“这样的格式来使用。

GitHub Actions 的徽章图标

以后,每次修改后推送源码,GitHub Actions 都会自动运行,那怎么知道运行的结果呢,GitHub Actions 为我们提供了徽标图标,可以加入到你的项目主页中,图标地址语法如下:

https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_NAME>/badge.svg?branch=<branch-name>
  • <OWNER>:所有者的用户名
  • <REPOSITORY>:项目仓库名称
  • <WORKFLOW_NAME>:工作流名称
  • <branch-name>:分支名称,如果不写默认是master分支

所以我的图标地址就是:https://github.com/renfei-net/WinterEE/workflows/build/badge.svg

我的使用感受

我之前一直使用的是TravisCI,这次使用了GitHub Actions以后感觉速度比TravisCI快很多,而且支持的东西也比TravisCI多,配置起来也不复杂,可玩性非常高,可以实现非常多自动化的东西,以后我主要就使用GitHub Actions来做CI/CD了。

GitHub Actions

商业用途请联系作者获得授权。
版权声明:本文为博主「任霏」原创文章,遵循 CC BY-NC-SA 4.0 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://www.renfei.net/posts/1003399
评论与留言
以下内容均由网友提交发布,版权与真实性无法查证,请自行辨别。

本站有缓存策略,时间约2小时后能看到您的评论。本站使用自动审核机制,如果您的内容包含广告/谩骂/恐怖/暴力/涉政等不和谐内容将无法展示!


本站有缓存策略,时间约2小时后能看到您的评论。本站使用自动审核机制,如果您的内容包含广告/谩骂/恐怖/暴力/涉政等不和谐内容将无法展示!

关注任霏博客
扫码关注「任霏博客」微信订阅号
微博:任霏博客网
Twitter:@renfeii
Facebook:任霏
最新留言 这个恶意攻击是只有服务器安装有Redis 才会遭受攻击吗 我用电脑和手机分别访问了45,133,203,192 这个ip地址,这个ip地址对应的服务器是不是只托管了脚本,提供木马自动去下载,并没有任何攻击性的东西,是这样的吗? 你好,我这边想问下,镜像服务启动了,该连接哪个数据库呢? 不更新? 优先级低的并不代表一定要等到优先级高的运行完才能运行,只是cpu分配的资源少了而已。 /lib64/ld-linux-x86-64.so.2: No such file or directory 报了这个错误,怎么解决呢 对于一个布道 DevOps 多年的选手来讲,看到这个报告,还是想继续布道布道。虽然是各种对比哈,但是我感觉与 DevOps 太像了(可能是职业病犯了哈)。首先声明本人不是GitLab 用户(因为不免费,没法薅羊毛啊),本人是 GitHub 忠实用户。 首先,你这是田忌赛马的对比,中文对比一事,着实有点可笑 1 土生土长和外来户能立马拉到同一个起跑线上吗? 2 一个真正的开发者应该去提升自己的英语能力,而不是拿全部是中文文档说事。大家都知道现在开源非常热,开发者是开源的主力军,如果要贡献优秀的开源项目(诸如Linux 内核,Kubernetes),英语就是个硬门槛。如果我是你,我倒希望公司内部的系统是英文的,最起码能让我锻炼英语,在看开源项目文档的时候不至于看不懂,提 PR 的时候不至于提交代码的内容描述不清楚而没法被 Merge。 其次,阿里云效、Coding 大家都知道背后站的是谁,很容易造成厂商绑定,现在很多企业都希望不要被厂商绑定。 再者,有一个点需要明白,GitLab 是一个 DevOps 平台,什么叫做 DevOps 平台(DevOps 走到现在,确切的说应该叫做 DevSecOps)?就是覆盖了软件开发生命周期全阶段的,从项目管理到代码托管到安全再到日志监控、甚至包含现在的云原生能力。不仅仅是说一个 CI/CD 就能概括的了的。这一点是 DevOps 布道的真正误区,我见过太多了,我在这儿再布道一哈,CI/CD 不等于 DevOps,他只是 DevOps 落地实践的核心能力。仅凭借一个 CI/CD 能有现成模版就判断出哪个好坏,过于牵强了吧。相信大家真正到项目用的时候,模版是满足不了要求的吧,毕竟大家都很特性化。 最后,还是一个很热的话题,开源,open source。GitLab 是开源的,Coding 和 云效这方面我没看到相关的开源内容(可能是我孤陋寡闻)。大家可以看看国内有多少用 GitLb 的,GitLab 的 CE 版,然后私有化部署,就是很多公司的代码托管 + DevOps 解决方案。 个人愚见,做一些对比报告的时候,还是先需要明白这个产品的定位,去深入挖掘一些真正有意义的对比,这样的对比报告才能有意义。作为一个常年写博客、文章的人来说。你写的每个字、每篇文章,你要想到你的思想会影响到别人。有可能因为你的片面之词,让别人错失一些学习的好机会。 docker run 那一长串后,出来一个字符串,然后去 docker containers 下面看 显示 exited(1);logs 下就一行错误 initdb failed 感谢🙏,第一个问题是空格的问题应该,我逐字敲完后可以构建了.第二个问题是我docker环境的问题,docker更新为最新版后需要重置配置文件.现已经正常使用,再次感谢您的分享和您的细心解答,期待下次相遇😄 还有一个问题可以请教下吗?就是我在容器里建文件夹没有权限,su root后密码不知道是多少,sudo mkdir xxx 提示我,没有sudo命令,请问有好的解决方法吗?谢谢解答 -v 后面可以指定文件吗 我的也是报错,还有。我执行了这个:@localhost kingbase-es-v8-r3-docker % docker run -d --name kingbase -p 54321:54321 -e SYSTEM_PWD=SYSTEM -v /opt/kingbase/data:/opt/kingbase/data -v /opt/kingbase:/opt/kingbase/Server/bin kingbase:v8r3 docker: 'run -d --name kingbase -p 54321:54321 -e SYSTEM_PWD=SYSTEM -v /opt/kingbase/data:/opt/kingbase/data -v /opt/kingbase:/opt/kingbase/Server/bin kingbase:v8r3' is not a docker command. See 'docker --help' 麻烦帮忙看下,是不是我写的命令有问题,还是版本问题,谢谢啦