Github Actions 还能做这些事

本文转载自微信公众号「crossoverJie」，作者crossoverJie。转载本文请联系crossoverJie公众号。

呼中ssl适用于网站、小程序/APP、API接口等需要进行数据传输应用场景，ssl证书未来市场广阔！成为创新互联的ssl证书销售渠道，可以享受市场价格4-6折优惠！如果有意向欢迎电话联系或者加微信：18980820575（备注：SSL证书合作）期待与您的合作！

前言

最近公司内部项目的发布流程接入了 GitHub Actions，整个体验过程还是比较美好的;本文主要目的是对于没有还接触过 GitHub Actions的新手，能够利用它快速构建自动测试及打包推送 Docker 镜像等自动化流程。

创建项目

本文主要以 Go 语言为例，当然其他语言也是类似的，与语言本身关系不大。

这里我们首先在 GitHub 上创建一个项目，编写了几段简单的代码 main.go：

 
 
 
 
      
  
  
  
  1. var version = "0.0.1" 
    2.   
  
  
  
  2.  
    3.   
  
  
  
  3. func GetVersion() string { 
    4.   
  
  
  
  4.  return version 
    5.   
  
  
  
  5. } 
    6.   
  
  
  
  6.  
    7.   
  
  
  
  7. func main() { 
    8.   
  
  
  
  8.  fmt.Println(GetVersion()) 
    9.   
  
  
  
  9. } 
    10.

内容非常简单，只是打印了了版本号;同时配套了一个单元测试 main_test.go：

 
 
 
 
      
  
  
  
  1. func TestGetVersion1(t *testing.T) { 
    2.   
  
  
  
  2.  tests := []struct { 
    3.   
  
  
  
  3.   name string 
    4.   
  
  
  
  4.   want string 
    5.   
  
  
  
  5.  }{ 
    6.   
  
  
  
  6.   {name: "test1", want: "0.0.1"}, 
    7.   
  
  
  
  7.  } 
    8.   
  
  
  
  8.  for _, tt := range tests { 
    9.   
  
  
  
  9.   t.Run(tt.name, func(t *testing.T) { 
    10.   
  
  
  
  10.    if got := GetVersion(); got != tt.want { 
    11.   
  
  
  
  11.     t.Errorf("GetVersion() = %v, want %v", got, tt.want) 
    12.   
  
  
  
  12.    } 
    13.   
  
  
  
  13.   }) 
    14.   
  
  
  
  14.  } 
    15.   
  
  
  
  15. } 
    16.

我们可以执行 go test 运行该单元测试。

 
 
 
 
      
  
  
  
  1. $ go test                           
    2.   
  
  
  
  2. PASS 
    3.   
  
  
  
  3. ok      github.com/crossoverJie/go-docker       1.729s 
    4.

自动测试

当然以上流程完全可以利用 Actions 自动化搞定。

首选我们需要在项目根路径创建一个 .github/workflows/*.yml 的配置文件，新增如下内容：

 
 
 
 
      
  
  
  
  1. name: go-docker 
    2.   
  
  
  
  2. on: push 
    3.   
  
  
  
  3. jobs: 
    4.   
  
  
  
  4.   test: 
    5.   
  
  
  
  5.     runs-on: ubuntu-latest 
    6.   
  
  
  
  6.     if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags') 
    7.   
  
  
  
  7.     steps: 
    8.   
  
  
  
  8.       - uses: actions/checkout@v2 
    9.   
  
  
  
  9.       - name: Run Unit Tests 
    10.   
  
  
  
  10.         run: go test 
    11.

简单解释下：

  • name 不必多说，是为当前工作流创建一个名词。
  • on 指在什么事件下触发，这里指代码发生 push 时触发，更多事件定义可以参考官方文档：

Events that trigger workflows

  • jobs 则是定义任务，这里只有一个名为 test 的任务。

该任务是运行在 ubuntu-latest 的环境下，只有在 main 分支有推送或是有 tag 推送时运行。

运行时会使用 actions/checkout@v2 这个由他人封装好的 Action，当然这里使用的是由官方提供的拉取代码 Action。

  • 基于这个逻辑，我们可以灵活的分享和使用他人的 Action 来简化流程，这点也是 GitHub Action扩展性非常强的地方。

最后的 run 则是运行自己命令，这里自然就是触发单元测试了。

  • 如果是 Java 便可改为 mvn test.

之后一旦我们在 main 分支上推送代码，或者有其他分支的代码合并过来时都会自动运行单元测试，非常方便。

与我们本地运行效果一致。

自动发布

接下来考虑自动打包 Docker 镜像，同时上传到 Docker Hub;为此首先创建 Dockerfile ：

 
 
 
 
      
  
  
  
  1. FROM golang:1.15 AS builder 
    2.   
  
  
  
  2. ARG VERSION=0.0.10 
    3.   
  
  
  
  3. WORKDIR /go/src/app 
    4.   
  
  
  
  4. COPY main.go . 
    5.   
  
  
  
  5. RUN go build -o main -ldflags="-X 'main.version=${VERSION}'" main.go 
    6.   
  
  
  
  6.  
    7.   
  
  
  
  7. FROM debian:stable-slim 
    8.   
  
  
  
  8. COPY --from=builder /go/src/app/main /go/bin/main 
    9.   
  
  
  
  9. ENV PATH="/go/bin:${PATH}" 
    10.   
  
  
  
  10. CMD ["main"] 
    11.

这里利用 ldflags 可在编译期间将一些参数传递进打包程序中，比如打包时间、go 版本、git 版本等。

这里只是将 VERSION 传入了 main.version 变量中，这样在运行时就便能取到了。

 
 
 
 
      
  
  
  
  1. docker build -t go-docker:last . 
    2.   
  
  
  
  2. docker run --rm go-docker:0.0.10 
    3.   
  
  
  
  3. 0.0.10 
    4.

接着继续编写 docker.yml 新增自动打包 Docker 以及推送到 docker hub 中。

 
 
 
 
      
  
  
  
  1. deploy: 
    2.   
  
  
  
  2.     runs-on: ubuntu-latest 
    3.   
  
  
  
  3.     needs: test 
    4.   
  
  
  
  4.     if: startsWith(github.ref, 'refs/tags') 
    5.   
  
  
  
  5.     steps: 
    6.   
  
  
  
  6.       - name: Extract Version 
    7.   
  
  
  
  7.         id: version_step 
    8.   
  
  
  
  8.         run: | 
    9.   
  
  
  
  9.           echo "##[set-output name=version;]VERSION=${GITHUB_REF#$"refs/tags/v"}" 
    10.   
  
  
  
  10.           echo "##[set-output name=version_tag;]$GITHUB_REPOSITORY:${GITHUB_REF#$"refs/tags/v"}" 
    11.   
  
  
  
  11.           echo "##[set-output name=latest_tag;]$GITHUB_REPOSITORY:latest" 
    12.   
  
  
  
  12.  
    13.   
  
  
  
  13.       - name: Set up QEMU 
    14.   
  
  
  
  14.         uses: docker/setup-qemu-action@v1 
    15.   
  
  
  
  15.  
    16.   
  
  
  
  16.       - name: Set up Docker Buildx 
    17.   
  
  
  
  17.         uses: docker/setup-buildx-action@v1 
    18.   
  
  
  
  18.  
    19.   
  
  
  
  19.       - name: Login to DockerHub 
    20.   
  
  
  
  20.         uses: docker/login-action@v1 
    21.   
  
  
  
  21.         with: 
    22.   
  
  
  
  22.           username: ${{ secrets.DOCKER_USER_NAME }} 
    23.   
  
  
  
  23.           password: ${{ secrets.DOCKER_ACCESS_TOKEN }} 
    24.   
  
  
  
  24.  
    25.   
  
  
  
  25.       - name: PrepareReg Names 
    26.   
  
  
  
  26.         id: read-docker-image-identifiers 
    27.   
  
  
  
  27.         run: | 
    28.   
  
  
  
  28.           echo VERSION_TAG=$(echo ${{ steps.version_step.outputs.version_tag }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV 
    29.   
  
  
  
  29.           echo LASTEST_TAG=$(echo ${{ steps.version_step.outputs.latest_tag  }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV 
    30.   
  
  
  
  30.  
    31.   
  
  
  
  31.       - name: Build and push Docker images 
    32.   
  
  
  
  32.         id: docker_build 
    33.   
  
  
  
  33.         uses: docker/build-push-action@v2.3.0 
    34.   
  
  
  
  34.         with: 
    35.   
  
  
  
  35.           push: true 
    36.   
  
  
  
  36.           tags: | 
    37.   
  
  
  
  37.             ${{env.VERSION_TAG}} 
    38.   
  
  
  
  38.             ${{env.LASTEST_TAG}} 
    39.   
  
  
  
  39.           build-args: | 
    40.   
  
  
  
  40.             ${{steps.version_step.outputs.version}} 
    41.

新增了一个 deploy 的 job。

 
 
 
 
      
  
  
  
  1. needs: test 
    2.   
  
  
  
  2.  if: startsWith(github.ref, 'refs/tags') 
    3.

运行的条件是上一步的单测流程跑通，同时有新的 tag 生成时才会触发后续的 steps。

name: Login to DockerHub

在这一步中我们需要登录到 DockerHub，所以首先需要在 GitHub 项目中配置 hub 的 user_name 以及 access_token.

配置好后便能在 action 中使用该变量了。

这里使用的是由 docker 官方提供的登录 action(docker/login-action)。

有一点要非常注意，我们需要将镜像名称改为小写，不然会上传失败，比如我的名称中 J 字母是大写的，直接上传时就会报错。

所以在上传之前先要执行该步骤转换为小写。

最后再用这两个变量上传到 Docker Hub。

今后只要我们打上 tag 时，Action 就会自动执行单测、构建、上传的流程。

总结

GitHub Actions 非常灵活，你所需要的大部分功能都能在 marketplace找到现成的直接使用，

比如可以利用 ssh 登录自己的服务器，执行一些命令或脚本，这样想象空间就很大了。

使用起来就像是搭积木一样，可以很灵活的完成自己的需求。

网站栏目：Github Actions 还能做这些事
转载注明：http://www.shufengxianlan.com/qtweb/news26/151576.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

python知识

各行业网站

奢侈品网站建设方案　　 　成都企业网站建设公司　　 　网站seo优化　　 　护栏打桩机　　 　西信服务器托管　　 　成都网站维护公司　　 　微信公众号开发　　 　成都网站建设公司　　 　手机app　　 　成都网站排名　　 　成都广告设计　　 　成都网络公司　　 　IDC机房托管　　 　新都网站建设　　 　网站建设开发　　 　添翼二手车鉴定评估　　 　腾讯云免备案主机　　 　成都学生服定制　　 　成都服务器托管　　 　四川服务器托管