GithubActions入门指南及实践

自从 github 提供了 github actions 后，个人或者依赖于 github 的公司可以考虑把持续集成方案迁到 github actions。

建网站原本是网站策划师、网络程序员、网页设计师等，应用各种网络程序开发技术和网页设计技术配合操作的协同工作。成都创新互联公司专业提供成都网站建设、成都网站设计,网页设计,网站制作(企业站、响应式网站建设、电商门户网站)等服务,从网站深度策划、搜索引擎友好度优化到用户体验的提升,我们力求做到极致!

github 会提供一个以下配置的服务器做为 runner，可以说相当良心了。

  • 2-core CPU
  • 7 GB of RAM memory
  • 14 GB of SSD disk space

另外如果你有网络时延的需求，(比如推送及拉取镜像时产生的网络时延)，你也可以自建 runner。

本文将介绍 github actions 的用法，以及如何使用它自动部署个人博客或者前端应用

快速开始

在 github 上进入个人仓库，找到 Actions 的标签页

Actions

如果你是一个前端项目，可以使用 Node.js 的模板，点击 Set up this workflow

Actions Setup

此时生成了一个文件 .github/workflows/nodejs.yaml，修改内容如下

 
 
 
 
    
  
  
  
  
  1. name: Git Action Test
    2. 
  
  
  
  
  2. 
  
  
  
  
  3. on: [push]
    4. 
  
  
  
  
  4. 
  
  
  
  
  5. jobs:
    6. 
  
  
  
  
  6.   build:
    7. 
  
  
  
  
  7. 
  
  
  
  
  8.     runs-on: ubuntu-latest
    9. 
  
  
  
  
  9. 
  
  
  
  
  10.     steps:
    11. 
  
  
  
  
  11.     - uses: actions/checkout@v1
    12. 
  
  
  
  
  12.     - name: Use Node.js 10.x
    13. 
  
  
  
  
  13.       uses: actions/setup-node@v1
    14. 
  
  
  
  
  14.       with:
    15. 
  
  
  
  
  15.         node-version: 10.x
    16. 
  
  
  
  
  16.     - name: npm install, build
    17. 
  
  
  
  
  17.       run: |
    18. 
  
  
  
  
  18.         npm install
    19. 
  
  
  
  
  19.         npm run build --if-present
    20. 
  
  
  
  
  20.       env:
    21. 
  
  
  
  
  21.         CI: true
    22.

执行 git push 操作，此时可以在 github 的 Actions 标签页看到执行结果

Actions Start

术语

runner: github 分配的用来执行 CI/CD 的构建服务器 (也可以自建 runner)

workflow: CI/CD 的工作流

job: 任务，比如构建，测试和部署。每个 workflow 由多个 job 组成

step: 每个 job 由多个 step 组成

配置

参考官方文档: Workflow syntax for GitHub Actions[1]

以下是常用到的配置

on

该 CI/CD 触发时的事件。如果需要上传代码自动部署的功能时，应该选择 on: push

 
 
 
 
    
  
  
  
  
  1. on: push
    2.

更多事件可以参考官方文档 Events that trigger workflows[2]

另外，我们可以利用 issues 事件做很多事情，如邮件通知之类

如果是 Issue 类博客，则可以通过监听 issues.opened 事件，调用 github api，自动生成网址博客

 
 
 
 
    
  
  
  
  
  1. on:
    2. 
  
  
  
  
  2.   issues:
    3. 
  
  
  
  
  3.     types: [opened, edited, milestoned]
    4.

jobs

一个 CI/CD 的工作流有许多 jobs 组成，比如最典型的 job 是 lint，test，build 或者 deploy。

 
 
 
 
    
  
  
  
  
  1. jobs:
    2. 
  
  
  
  
  2.   test:
    3. 
  
  
  
  
  3.   build:
    4. 
  
  
  
  
  4.   deploy:
    5.

所有的 job 都是并行的，但往往会有依赖关系：「你总得通过测试了，才能再去部署吧」

jobs..needs

needs 确定 job 的依赖关系

 
 
 
 
    
  
  
  
  
  1. jobs:
    2. 
  
  
  
  
  2.   test:
    3. 
  
  
  
  
  3.   deploy:
    4. 
  
  
  
  
  4.     needs: test
    5.

jobs..runs-on

当你使用 github actions 时，github 会十分大方的给你分配一个配置还不错的服务器作为构建服务器，用来跑你的 workflow

  • 2-core CPU
  • 7 GB of RAM memory
  • 14 GB of SSD disk space

恩，比我自己的服务器要强

使用 runs-on 指定服务器系统，用的最多的应该就是 ubuntu-latest 了

 
 
 
 
    
  
  
  
  
  1. runs-on: ubuntu-latest
    2. 
  
  
  
  
  2. 
  
  
  
  
  3. runs-on: windows-latest
    4.

jobs..steps

即某个任务的一系列动作，如部署一个前端需要安装依赖，编译代码等等

jobs..steps.name

为 step 指定一个名称，将会在 github action 的控制台中显示

jobs..steps.run

该 step 需要在 shell 中执行的命令

 
 
 
 
    
  
  
  
  
  1. # 单行
    2. 
  
  
  
  
  2. - name: Install Dependencies
    3. 
  
  
  
  
  3.   run: npm install
    4. 
  
  
  
  
  4. 
  
  
  
  
  5. # 多行
    6. 
  
  
  
  
  6. - name: Install and Build
    7. 
  
  
  
  
  7.   run: |
    8. 
  
  
  
  
  8.     npm install
    9. 
  
  
  
  
  9.     npm run build
    10.

jobs..steps.uses

选择一个 action，可以理解为若干 steps.run，有利于代码复用。这也是 github action 最主要的功能。

如果你想找一个好用的 github action，可以在 github marketplace 浏览并检索

这是一个在当前操作系统中安装 node:10 的 action 示例

 
 
 
 
    
  
  
  
  
  1. - name: use Node.js 10.x
    2. 
  
  
  
  
  2.   uses: actions/setup-node@v1
    3. 
  
  
  
  
  3.   with:
    4. 
  
  
  
  
  4.     node-version: 10.x
    5.

当然，这里怎么能少得了 docker 的身影呢，在 actions 中也可以使用 docker。如果对 docker 不太了解，可以看我的文章: docker 简易入门[3]

以下是 npm install 的一个示例

 
 
 
 
    
  
  
  
  
  1. jobs:
    2. 
  
  
  
  
  2.   build:
    3. 
  
  
  
  
  3.     steps:
    4. 
  
  
  
  
  4.       - name: Install
    5. 
  
  
  
  
  5.         uses: docker://node:alpine
    6. 
  
  
  
  
  6.         with:
    7. 
  
  
  
  
  7.           args: npm install
    8.

secret and context

如何在 github action 上访问敏感数据?如使用 ssh 登录时如何维护密码。

我们可以在 github repo 上依次点击 Settings -> Secrets 设置 secret

Actions Secrect

 
 
 
 
    
  
  
  
  
  1. - name: setup aliyun oss
    2. 
  
  
  
  
  2.   uses: manyuanrong/setup-ossutil@master
    3. 
  
  
  
  
  3.   with:
    4. 
  
  
  
  
  4.     endpoint: oss-cn-beijing.aliyuncs.com
    5. 
  
  
  
  
  5.     access-key-id: ${{ secrets.OSS_KEY_ID }}
    6. 
  
  
  
  
  6.     access-key-secret: ${{ secrets.OSS_KEY_SECRET }}
    7.

这里的 secret 就是一种 context，描述 CI/CD 一个 workflow 中的上下文信息，使用 ${{ expression }} 语法表示。除了 secret，还有

  • github: workflow 的信息，如 github.sha 可以获取当前的 commit SHA，我们可以利用它为 sentry 或者 docker image 打入版本号
  • env: 环境变量
  • job: 当前执行 job 的信息，如 job.status 表示当前 job 的执行状态
  • matrix: 描述一些构建信息，如 node 以及 os 版本号

更多 context 信息可以参考官方文档 Contexts and expression syntax for GitHub Actions[4]

实践一：博客自动部署

我的博客目前托管在阿里云 OSS 上，以下 action.yaml 描述了自动部署的流程。可以参考我的配置 shfshanyue/blog[5]

「关于托管在阿里云 OSS 的细节，可以参考 在阿里云 OSS 托管你的前端应用[6]」

 
 
 
 
    
  
  
  
  
  1. name: deploy to aliyun oss
    2. 
  
  
  
  
  2. 
  
  
  
  
  3. on: [push]
    4. 
  
  
  
  
  4. 
  
  
  
  
  5. jobs:
    6. 
  
  
  
  
  6.   build:
    7. 
  
  
  
  
  7. 
  
  
  
  
  8.     runs-on: ubuntu-latest
    9. 
  
  
  
  
  9. 
  
  
  
  
  10.     steps:
    11. 
  
  
  
  
  11.     # 切代码到 runner
    12. 
  
  
  
  
  12.     - uses: actions/checkout@v1
    13. 
  
  
  
  
  13.       with:
    14. 
  
  
  
  
  14.         submodules: true
    15. 
  
  
  
  
  15.     # 下载 git submodule
    16. 
  
  
  
  
  16.     - uses: srt32/git-actions@v0.0.3
    17. 
  
  
  
  
  17.       with:
    18. 
  
  
  
  
  18.         args: git submodule update --init --recursive
    19. 
  
  
  
  
  19.     # 使用 node:10
    20. 
  
  
  
  
  20.     - name: use Node.js 10.x
    21. 
  
  
  
  
  21.       uses: actions/setup-node@v1
    22. 
  
  
  
  
  22.       with:
    23. 
  
  
  
  
  23.         node-version: 10.x
    24. 
  
  
  
  
  24.     # npm install
    25. 
  
  
  
  
  25.     - name: npm install and build
    26. 
  
  
  
  
  26.       run: |
    27. 
  
  
  
  
  27.         npm install
    28. 
  
  
  
  
  28.         npm run build
    29. 
  
  
  
  
  29.       env:
    30. 
  
  
  
  
  30.         CI: true
    31. 
  
  
  
  
  31.     # 设置阿里云OSS的 id/secret，存储到 github 的 secrets 中
    32. 
  
  
  
  
  32.     - name: setup aliyun oss
    33. 
  
  
  
  
  33.       uses: manyuanrong/setup-ossutil@master
    34. 
  
  
  
  
  34.       with:
    35. 
  
  
  
  
  35.         endpoint: oss-cn-beijing.aliyuncs.com
    36. 
  
  
  
  
  36.         access-key-id: ${{ secrets.OSS_KEY_ID }}
    37. 
  
  
  
  
  37.         access-key-secret: ${{ secrets.OSS_KEY_SECRET }}
    38. 
  
  
  
  
  38.     - name: cp files to aliyun
    39. 
  
  
  
  
  39.       run: ossutil cp -rf .vuepress/dist oss://shanyue-blog/
    40.

部署成功

部署成功

实践二：Github Readme 自动生成

2020 年 8 月份，就是我裸辞的那个月，Github 上线了个人主页功能，即创建 Github 用户名的同名 Repo，其中的 Readme.md 就是自己的个人主页。例如我，创建一个 shfshanyue/shfshanyue 的仓库，既可以通过 Readme.md 来创建个人主页

此时涌现了各种各样的 Github Actions 来自定义个人主页，大致思路如下：

  1. Github API 获取自身 Github 动态，写入指定格式的 Readme
  2. Github Actions 自动提交代码

优秀 Github 个人主页的 Actions[7]

其中一个 waka-readme-stats[8]，可制作以下漂亮的个人主页

 
 
 
 
    
  
  
  
  
  1.  I'm Most Productive on Sundays
    2. 
  
  
  
  
  2. 
  
  
  
  
  3. Monday       50 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.19%
    4. 
  
  
  
  
  4. Tuesday      85 commits     █████░░░░░░░░░░░░░░░░░░░░   22.43%
    5. 
  
  
  
  
  5. Wednesday    56 commits     ███░░░░░░░░░░░░░░░░░░░░░░   14.78%
    6. 
  
  
  
  
  6. Thursday     44 commits     ███░░░░░░░░░░░░░░░░░░░░░░   11.61%
    7. 
  
  
  
  
  7. Friday       28 commits     █░░░░░░░░░░░░░░░░░░░░░░░░   7.39%
    8. 
  
  
  
  
  8. Saturday     30 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   7.92%
    9. 
  
  
  
  
  9. Sunday       86 commits     █████░░░░░░░░░░░░░░░░░░░░   22.69%
    10.

实践三：定时任务的脚本服务器

「这简直是在薅羊毛啊!」

先献上一个使用了 Github Actions 的工具：B 站自动签到工具[9]。

通过 GitHub Actions 实现每日线上自动运行任务：每日自动登录、观看、分享、投币视频，获取每日任务的满额经验，轻松升级 Level 6，实现自动领取大会员权益、月底自动为自己充电等功能。

关于其它有趣的可薅羊毛的定时任务，就需要充分发挥你的想象力了!

Reference

[1]Workflow syntax for GitHub Actions:

https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions[2]Events that trigger workflows:

https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#about-workflow-events[3]docker 简易入门:

https://github.com/shfshanyue/op-note/blob/master/docker.md[4]Contexts and expression syntax for GitHub Actions:

https://help.github.com/en/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions#job-context[5]shfshanyue/blog:

https://github.com/shfshanyue/blog/blob/master/.github/workflows/nodejs.yml[6]在阿里云OSS托管你的前端应用:

./deploy-fe-with-alioss.md[7]优秀 Github 个人主页的 Actions:

https://github.com/abhisheknaiidu/awesome-github-profile-readme#github-actions-[8]waka-readme-stats:

https://github.com/anmol098/waka-readme-stats[9]B站自动签到工具:

https://github.com/RayWangQvQ/BiliBiliTool

本文转载自微信公众号「 全栈成长之路」，可以通过以下二维码关注。转载本文请联系 全栈成长之路公众号。

网站标题：GithubActions入门指南及实践
URL链接：http://www.hantingmc.com/qtweb/news37/288737.html

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

广告

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

猜你还喜欢下面的内容

搜索引擎优化知识

同城分类信息

泸州叙永网站建设　　 　广安网站建设　　 　卖链接　　 　电商网店　　 　成都移动机房　　 　成都婚庆策划　　 　主机租用　　 　网络营销公司　　 　成都网创优客　　 　资阳网站建设　　 　鼎尚理发店　　 　解决方案　　 　网站建设公司　　 　重庆电商网站定制　　 　力比特机械　　 　无边发光字制作　　 　网站制作报价　　 　广汉锦华建材　　 　虚拟主机购买　　 　内江网站建设