GithubActions · Mr.li's Blog

> 本文由 [简悦 SimpRead](http://ksria.com/simpread/) 转码， 原文地址 [nymrli.top](https://nymrli.top/2020/11/12/GithubAction/)

[GitHub Actions](https://github.com/features/actions) 是 GitHub 的[持续集成服务](http://www.ruanyifeng.com/blog/2015/09/continuous-integration.html)，于 2018 年 10 月[推出](https://github.blog/changelog/2018-10-16-github-actions-limited-beta/)。

[](#github-actions-是什么)GitHub Actions 是什么？
------------------------------------------

大家知道，持续集成由很多操作组成，比如抓取代码、运行测试、登录远程服务器，发布到第三方服务等等。GitHub 把这些操作就称为 actions。

很多操作在不同项目里面是类似的，完全可以共享。GitHub 注意到了这一点，想出了一个很妙的点子，允许开发者把每个操作写成独立的脚本文件，存放到代码仓库，使得其他开发者可以引用。

如果你需要某个 action，不必自己写复杂的脚本，直接引用他人写好的 action 即可，整个持续集成过程，就变成了一个 actions 的组合。这就是 GitHub Actions 最特别的地方。

GitHub 做了一个[官方市场](https://github.com/marketplace?type=actions)，可以搜索到他人提交的 actions。另外，还有一个 [awesome actions](https://github.com/sdras/awesome-actions) 的仓库，也可以找到不少 action。

[](#基础名词概念)基础名词概念
-----------------

GitHub Actions 有一些自己的术语。  
（1）**workflow** （工作流程）：持续集成一次运行的过程，就是一个 workflow。  
（2）**job** （任务）：一个 workflow 由一个或多个 jobs 构成，含义是一次持续集成的运行，可以完成多个任务。  
（3）**step**（步骤）：每个 job 由多个 step 构成，一步步完成。  
（4）**action** （动作）：每个 step 可以依次执行一个或多个命令（action）。

[GitHub Actions 阮一峰](http://www.ruanyifeng.com/blog/2019/09/getting-started-with-github-actions.html)

具体内容说明:

*   name 自动构建的名字
*   on 触发条件
    *   watch 监视
        *   type:started 类型：点击了星标
    *   可以是数组： [push, pull_request]
*   env 环境变量
*   jobs 任务
*   build 工作的 id
*   run-on 工作运行的环境平台
*   if 工作运行的判断
*   steps 包含一系列任务步骤
    *   name 子任务名
    *   uses 使用官方的一些 action 库完成一些操作
    *   run 运行脚本
    *   id 运行 id

[](#workflow-文件)workflow 文件
---------------------------

GitHub Actions 的配置文件叫做 workflow 文件，存放在代码仓库的`.github/workflows`目录。

workflow 文件采用 [YAML 格式](http://www.ruanyifeng.com/blog/2016/07/yaml.html)，文件名可以任意取，但是后缀名统一为`.yml`，比如`foo.yml`。一个库可以有多个 workflow 文件。GitHub 只要发现`.github/workflows`目录里面有`.yml`文件，就会自动运行该文件。

* * *

综上, Github actions 配合 GithubPages 会非常方便

**什么是 GitHub Pages?**

打开 GitHub Pages 的首页我们会看到如下图所示：  
他可以当做你或者你的项目的 Websites，那么我们可以知道 GitHub Pages 有两种最基本的用法：

1.  作为你自己（或者组织）的网站（访问地址示例：[http://username.github.io](https://link.zhihu.com/?target=http%3A//username.github.io/)）
2.  作为你某一个项目的网站（访问地址示例：[http://username.github.io/projectname](https://link.zhihu.com/?target=http%3A//username.github.io/projectname)）
3.  由于性能不太好, 因此最主要的用途是作为部署静态网页, 给 demo 展示: 做 demo 展示不同于做项目开发, 我们需要的是快速轻便的开发和部署, 而不是完备的一整套开发流程.

Github pages 的好处

1.  **使用零成本:** github pages 集成在 github 中, 直接和代码管理绑定在一起, 随着代码更新自动重新部署, 使用非常方便.
2.  **免费:** 免费提供 [username.github.io](http://username.github.io/) 的域名, 免费的静态网站服务器.
3.  **无数量限制:** github pages 没有使用的数量限制, 每一个 github repository 都可以部署为一个静态网站.

* * *

[](#workflowdemo)workflowDemo
-----------------------------

### [](#官方demo)官方 demo

默认的生成模板: 会在仓库的`./github/workflows`目录下创建一个`.yml`的文件

```
name: CI

on:
 push:
 branches: [ main ]
 pull_request:
 branches: [ main ]

jobs:
  
 build:
    
    
 runs-on: ubuntu-latest

steps:
      
      
 - uses: actions/checkout@v2

- name: Run a one-line script
 run: echo Hello, world!

- name: Run a multi-line script
 run: |
          echo Add other actions to build,
          echo test, and deploy your project.
```

### [](#bilibilitool的workflow)**[BiliBiliTool 的 workflow](https://github.com/RayWangQvQ/BiliBiliTool)**

```
name: bilibili-daily-task

on:
  
 push: 
 branches: [ main ]
 workflow_dispatch: 
 schedule: 
 - cron: '10 6 * * *'

jobs:
 run-bilibili-tool:

runs-on: ubuntu-latest

steps:
    
    
 - name: Checkout
 uses: actions/checkout@v2
      
    
 - name: Set time zone
 run: sudo timedatectl set-timezone 'Asia/Shanghai'
      
    
 - name: Setup .NET Core
 uses: actions/setup-dotnet@v1
 with:
 dotnet-version: 3.1.301

- name: Install dependencies
 run: dotnet restore
      
    
 - name: Build
 run: dotnet build --configuration Release --no-restore
       
    
 - name: Run
      
 env:
 userId: ${{secrets.USERID}}
 sessData: ${{secrets.SESSDATA}}
 biliJct: ${{secrets.BILIJCT}}
 otherConfigs: ${{secrets.OTHERCONFIGS}}
 run: dotnet run -p ./src/Ray.BiliBiliTool.Console -userId=${userId} -sessData=${sessData} -biliJct=${biliJct} -closeConsoleWhenEnd=1 ${otherConfigs}
```