Github Action 快速上手指南

电玩女神 2022-10-31 00:50 187阅读 0赞

# 前言 #

各位读者，新年快乐，我是过了年匆忙赶回上海努力搬砖的蛮三刀。

Github之前更新了一个Action功能（应该是很久以前了），可以实现很多自动化操作。用来替代用户自己设置的自动化脚本（比如：钩子+Jenkins）。

由于平时根本不会有需求用到它，毕竟平时都在用公司的CI/CD流程，所以一直没有机会玩Action。

借着春节放假，就自己写个小Demo体验一下。

本文通过实现一个**提交代码后自动执行Junit单元测试并输出测试报告的自动化流程**小Demo，来快速上手Github Action。

# Github Action 是什么？ #

如果你对Github Action完全没有概念，我推荐先去看一下CI/CD（持续集成/持续交付）的概念：

https://www.redhat.com/zh/topics/devops/what-is-ci-cd

Github Action官方文档中对自身的定义：

> 在 GitHub Actions 的仓库中自动化、自定义和执行软件开发工作流程。 您可以发现、创建和共享操作以执行您喜欢的任何作业（包括 CI/CD），并将操作合并到完全自定义的工作流程中。

用人话说，**就是你可以给你的代码仓库部署一系列自动化脚本，在你进行了提交/合并分支等操作后，自动执行脚本。**

阮一峰Github Action指南中的介绍：

> 大家知道，持续集成由很多操作组成，比如抓取代码、运行测试、登录远程服务器，发布到第三方服务等等。GitHub 把这些操作就称为 actions。
> 
> 很多操作在不同项目里面是类似的，完全可以共享。GitHub 注意到了这一点，想出了一个很妙的点子，允许开发者把每个操作写成独立的脚本文件，存放到代码仓库，使得其他开发者可以引用。
> 
> 如果你需要某个 action，不必自己写复杂的脚本，直接引用他人写好的 action 即可，整个持续集成过程，就变成了一个 actions 的组合。这就是 GitHub Actions 最特别的地方。

GitHub Actions 有一些自己的术语：

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

看这些介绍和定义，其实比较枯燥，我们直接来看代码实现，在代码中来理解这些定义和指令。

# 快速上手 #

## 给仓库创建新文件夹.github/workflow ##

首先，用你自己的任意GitHub仓库，在仓库内添加文件夹`.github/workflow` 或者`.github/workflows`：

![6518dc8b44513c9ce586f1c32557d1d2.png][]

> 一个库可以有多个 workflow 文件。GitHub 只要发现.github/workflows目录里面有.yml文件，就会自动运行该文件。

## 撰写你的workflow ##

一个yml脚本便是Action的核心了，我们新建一个`blank.yml`，内容如下：

![4e76a26bd04bc83b75f7c76252efbfe6.png][]

我在代码里做了一些注释，帮助大家理解每个指令的含义。

整个脚本大致的流程如下：

*  指定在push或者pull request时触发脚本执行
 *  拉取ubuntu最新版的镜像
 *  缓存Maven依赖目录，避免每次都下载全量依赖包，加快执行速度
 *  安装Java8
 *  指定pom.xml文件路径，随后用Maven编译项目
 *  运行Junit单元测试

## 给项目撰写单元测试代码 ##

ok，写完脚本，我们需要来编写一些测试代码，让Junit有事可做。

我使用了自己的一个仓库，上面有完整的action脚本和测试类代码，供参考：

https://github.com/qqxx6661/awesome-utils

这是一个Maven仓库，我们在test文件夹内加入测试代码。

![f9014935d4de7e6c9ce877298fdaac23.png][]

上面的测试代码测试的是下面的一个静态方法：

![bbdbe412bfae17039fdbe808452a3f3c.png][]

## 提交代码，触发Github Action执行 ##

将代码commit并push后，点开你的仓库主页，点击Action标签：

![a405262471b2b005bc291fbef28d2e13.png][]

可以看到已经有了执行信息。

接着看下我们的Action到底有没有执行，点开Action标签，已经发现了Junit：

![79946446eac4a6f5c555d51eaf584bfd.png][]

可以进行脚本代码的在线编辑：

![a30668f4e753279ae5bad460bdeaa925.png][]

点进本次commit执行的记录，可以看到，action顺利完成了几个步骤：

![cbde4de93b665f5e4feea688ef86f75b.png][]

点开Maven的构建日志，可以看到我们第一次跑action，所有的依赖还是即时下载的：

![6c3e98b40e443485d18e1cfa73405c36.png][]

单元测试运行的日志输出正常：

![7295e15d67091863631d7d4aaf6c233d.png][]

为了试验Maven的依赖包是否能够使用到缓存，我们再写几个单元测试，然后commit：

![be2793ec9cf5b25f66cdd5d47e577ea1.png][]

可以看到，新的action日志里直接开始了编译，不再需要下载全量的包：

![aea3aa810478838e1b143e552e0860f9.png][]

单元测试页成功执行：

![feeb635f411171524321289d71b8623f.png][]

至此，我们的简易入门教程便结束了。

# 还有很多功能等待探索 #

当然，这还只是Action的冰山一角，其能做的事情远不止于此：

*  编译打包代码
 *  自动上传至公有云/App容器
 *  单元测试/代码覆盖率测试/文档同步/发布版本

等着你们的探索。

![ad476beae77f71b7b1f5538935d68095.png][]

# 参考 #

https://docs.github.com/cn/actions/guides/building-and-testing-python\#publishing-to-package-registries

http://www.ruanyifeng.com/blog/2019/09/getting-started-with-github-actions.html

# 关注我 #

我是一名奋斗在一线的互联网后端开发工程师。

平时主要关注后端开发，数据安全，边缘计算等方向，欢迎交流。

**各大平台都能找到我**

*  **微信公众号：后端技术漫谈**
 *  **Github：[@qqxx6661][qqxx6661]**
 *  CSDN：[@蛮三刀把刀][Link 1]
 *  知乎：[@后端技术漫谈][Link 2]
 *  掘金：[@蛮三刀把刀][Link 3]
 *  腾讯云+社区：[@后端技术漫谈][Link 4]
 *  博客园：[@后端技术漫谈][Link 5]
 *  BiliBili：[@蛮三刀把刀][Link 6]

**原创文章主要内容**

*  后端开发实战
 *  后端技术面试
 *  算法题解/数据结构/设计模式
 *  生活感悟

**个人公众号：后端技术漫谈**

![个人公众号：后端技术漫谈][e963a6996f115b4fa82ffc9dee19ea5c.png]

**如果文章对你有帮助，求各位大佬点赞支持一下，你的点赞和在看是我更新的动力~**

[6518dc8b44513c9ce586f1c32557d1d2.png]: /images/20221024/fe5ed400637d4898baf511ff2b1b5bf2.png
[4e76a26bd04bc83b75f7c76252efbfe6.png]: /images/20221024/f9536127a9414e479e6cb39f78af6669.png
[f9014935d4de7e6c9ce877298fdaac23.png]: /images/20221024/2ba2f0d810d746589c4f2609f412d437.png
[bbdbe412bfae17039fdbe808452a3f3c.png]: /images/20221024/1fa0db6a27954098a9449e65e1983c80.png
[a405262471b2b005bc291fbef28d2e13.png]: /images/20221024/23fd8e939788417cba08dabc3b185e99.png
[79946446eac4a6f5c555d51eaf584bfd.png]: /images/20221024/4f102383c3e840198a89858bad86fdcf.png
[a30668f4e753279ae5bad460bdeaa925.png]: /images/20221024/e2ea61a91af545b8a0f1bcf50109c1c8.png
[cbde4de93b665f5e4feea688ef86f75b.png]: /images/20221024/7f5d02d2379b4337b28ccd60fb1d636b.png
[6c3e98b40e443485d18e1cfa73405c36.png]: /images/20221024/391267d6c04849319a96488f1309a336.png
[7295e15d67091863631d7d4aaf6c233d.png]: /images/20221024/a64448b654a946adbdf62819707f5e96.png
[be2793ec9cf5b25f66cdd5d47e577ea1.png]: /images/20221024/09cc925b375e41e7b584338b705ee5ef.png
[aea3aa810478838e1b143e552e0860f9.png]: /images/20221024/2667aa3e0a49487d82323827f17b7b10.png
[feeb635f411171524321289d71b8623f.png]: /images/20221024/208b02bc78934277a55fa297b97f826f.png
[ad476beae77f71b7b1f5538935d68095.png]: /images/20221024/54fc3676efd74928858bf0a6bd7b889d.png
[qqxx6661]: https://github.com/qqxx6661
[Link 1]: http://blog.csdn.net/qqxx6661
[Link 2]: https://www.zhihu.com/people/yang-zhen-dong-1/
[Link 3]: https://juejin.im/user/5b48015ce51d45191462ba55
[Link 4]: https://cloud.tencent.com/developer/user/1706868
[Link 5]: https://www.cnblogs.com/rude3knife/
[Link 6]: https://space.bilibili.com/18324091
[e963a6996f115b4fa82ffc9dee19ea5c.png]: /images/20221024/6b66d1ea79ef472ab66eb0953a126f26.png