手把手系列之零基础:Github Actions使用入门

之前在github上使用CI/CD我们通常使用的是travis，现在我们多了一个选择，那就是官方的Github Actions。

下面我们简单介绍一下如何使用Github Actions。

这里我们先简单介绍一下一些基本的概念。

1. actions，一个action代表一个独立的任务（individual task）
2. 一个或多个actions组成一个工作流（workflow）
3. 一个工作流由多个jobs组成（个人感觉其实job就等同于action）
4. 一个 job包含一个或多个步骤（steps）

workflow以yaml文件的格式存储在你代码.github/workflows/目录下。文件名必须以yml或yaml结尾。可以有多个yaml文件。

这里还是使用我们之前一直使用的示例代码来演示，地址https://github.com/zhuyijing/fastapisvc

首先点击Actions：

选择Python Application作为我们的模板：

点击Setup this workflow之后会跳转到以下页面：

我们来看一下生成的yaml文件，我在其中添加了一些注释：

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Python application

# 当有commit push到master branch或者有提交PR到master branch时触发
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    # 在最新的ubuntu版本上运行
    runs-on: ubuntu-latest

    steps:
    # 第一步调用官方的action checkout代码
    - uses: actions/checkout@v2
    # 第二步setup Python环境
    - name: Set up Python 3.8
      uses: actions/setup-python@v2
      with:
        python-version: 3.8
    # 第三步从requirements安装依赖，并安装lint工具
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
    # 第四步运行lint
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    
         - name: Test with pytest
      run: |
        pytest

好了，我们现在点击Start commit来提交刚刚生成的yaml文件。

可以看到yaml文件已经被提交到版本库中了：

点击repo的名字，回到repo的首页：

这里可以看到，我们刚刚提交的commit（也就是刚刚提交的workflow yaml）运行失败了。我们点击红色的叉叉，然后点击Details：

这里可以看到pytest运行失败了，这是因为我们的repo里面没有编写测试用例。这里我们来修改一下workflow的yaml文件，删除掉pytest：

点击上图红色框中的笔图标进入编辑：

删除掉pytest的那几行，然后点击Start commit：

再次回到repo的首页，等待一会儿，刷新一下，可以看到刚才提交的Action已经通过了：

是不是很简单。

下面我们来试一下，把他编译成docker image并且上传到Docker Hub。这里你需要提前注册好你的Docker Hub账号，具体怎么注册可以参考我之前发布的文章。

下面，我们首先来注册一下github的secrets，secrets是你需要在workflow中用到，但是又不方便直接写在yaml中的一些数据，如用户名，密码。

同样在你饿项目首页，一次点击 setting，secrets，New secret：

依次添加2个secrets，DOCKER_HUB_USER & DOCKER_HUB_PASSWORD：

添加完你可以看到你所添加的secrets：

好了，我们现在再次编辑.github/workflows/pythonapp.yml文件：

在Marketplace下面的搜索框输入Docker，然后点击第一个Build and push docker images：

点击上图中的复制图标，然后在代码粘贴到左边的文件中，删除其中大部分的选项，只保留如下代码：

- name: Build and push Docker images
  uses: docker/build-push-action@v1.1.0
  with:
    username: ${{ secrets.DOCKER_HUB_USER }}
    password: ${{ secrets.DOCKER_HUB_PASSWORD }}
    repository: zhuyijing/myfirstrepo
    tags: latest

注意把repository替换成你自己的repository。修改完的文件如下图：

点击上图中的Start commit，返回到repo首页，你会看到刚刚的提交前面有一个黄色的小点，表示actions正在运行：

稍等一会儿刷新页面：

可以看到Action已经运行成功了，点击绿色小勾，然后点击Details，可以看到我们刚刚添加的task也运行成功了：

登录到你的Docker Hub，可以看到image也已经push上来了。

通过以上的配置，这样以后每次有push、PR到master branch上都会触发Actions进行lint检查并push最新的image到Docker Hub上。

是不是很简单呢。官方的Marketplace提供了非常多的有用的actions，常用的都有。基本不需要我们手动编写很多的yaml。使用起来十分的方便。

赶紧试试吧。

PS：点击Actions可以看到每次的运行结果：