我们一起GithubAction入门

本文转载自微信公众号「老王Plus」，作者老王Plus的老王。转载本文请联系老王Plus公众号。

我们提供的服务有：网站设计制作、做网站、微信公众号开发、网站优化、网站认证、商城ssl等。为1000+企事业单位解决了网站和推广的问题。提供周到的售前咨询和贴心的售后服务，是有科学管理、有技术的商城网站制作公司

Github Action，是 Github 推出的一个持续集成服务。

这个持续集成，有很多操作，例如：抓取代码、运行测试、登录远程服务器，发布到第三方服务等等。就我自己而言，用的最多的是自动生成 Nuget 包并自动发布到 Nuget。这样，我可以只关心代码本身，代码完成后，Push 到仓库，后面就由 Action 去自动完成了。

这篇文章，我会从零开始，介绍一下 Action 的创建和使用。

一、在 Dotnet 工程中加入一个 Github Action

我们在 Github 上创建一个简单的 Dotnet 应用。看一下目录结构：

 
 
 
    
  
  
  
  1. % tree -a . 
    2.   
  
  
  2. . 
    3.   
  
  
  3. ├── .gitignore 
    4.   
  
  
  4. ├── GithubActionSample.sln 
    5.   
  
  
  5. ├── README.md 
    6.   
  
  
  6. ├── src 
    7.   
  
  
  7. │   ├── GithubActionSample.csproj 
    8.   
  
  
  8. │   └── Program.cs 
    9.   
  
  
  9. └── tests 
    10.

初始基本就是这么个样子。通常我会加入几个文件：README.md，用来写个说明;.gitignore，这个是提交时，定义跳过某些文件的定义，比方 bin、obj 下面的文件，是不需要提交上去的;tests 目录，里面是测试代码。当然，这儿我就省了。

Github Action 需要放在一个固定位置 - 在 Git 仓库的根目录中。

我们创建一个 .github 的目录，并在里面创建一个 workflows 的子目录。这就是我们要创建 Action 的目录了。注意，这个目录名称和结构不能改变。Github 会在这个位置查找工作流配置。

下面，我们在这个位置创建一个 Action 的定义。Action 要求是 YAML 文件。关于这个文件的格式，后面会讲到。

这个目录下，可以创建多个 YAML 文件，对应多个工作流的配置，每个工作流配置，对应不同的自动化需求。

我们先创建一个 Action，用来自动编译代码，文件名叫 Build.yml。完成后，看一下目录结构：

 
 
 
    
  
  
  
  1. % tree -a . 
    2.   
  
  
  2. . 
    3.   
  
  
  3. ├── .github 
    4.   
  
  
  4. │   └── workflows 
    5.   
  
  
  5. │       └── Build.yml 
    6.   
  
  
  6. ├── .gitignore 
    7.   
  
  
  7. ├── GithubActionSample.sln 
    8.   
  
  
  8. ├── README.md 
    9.   
  
  
  9. ├── src 
    10.   
  
  
  10. │   ├── GithubActionSample.csproj 
    11.   
  
  
  11. │   └── Program.cs 
    12.   
  
  
  12. └── tests 
    13.

这就是一个 Action 了。

下面，我们来一步步完成这个 Action 的配置。

二、完成 Action 配置

完成 Action 配置，其实就是完成上面这个 Build.yml 文件的内容。

1. 指定 Action 名称

先说明一下，按照 Github 的说明，这个名称不是必须的。不过通常来说，我会习惯加个名称。根据文件名判断作用，不是个好习惯。

格式很简单：

 
 
 
    
  
  
  
  1. name: Sample build 
    2.

2. 配置触发器

触发器，是用来定义这个 Action 在什么情况下被运行。

通常来说，会有几种选择：

  • 单个事件，比方提交代码 Push 的时候，写法是：
 
 
 
    
  
  
  
  1. on: push 
    2.
  • 多个事件，比方 Push 和 Pull Request 的时候，写法是：
 
 
 
    
  
  
  
  1. on: [push, pull_request] 
    2.

有时候，我们还需要增加更多的条件，比方 Push 和 Pull Request 到主分支的时候：

 
 
 
    
  
  
  
  1. on: 
    2.   
  
  
  2.     push: 
    3.   
  
  
  3.         branches: 
    4.   
  
  
  4.             - main 
    5.   
  
  
  5.     pull_request: 
    6.   
  
  
  6.         branches: 
    7.   
  
  
  7.             - main 
    8.

还有一个非常有用的触发器，就是定时器。比方我们要在特定的时间，或特定的周期下运行这个 Action，就可以用定时器。

定时器的写法是：

 
 
 
    
  
  
  
  1. on: 
    2.   
  
  
  2.   schedule: 
    3.   
  
  
  3.     - cron:  '5 * * * *' 
    4.

这个定时器，采用的是 Linux 下 Cron 的定时器写法。具体的写法和含义，可以去查一下 Cron 的规则。

除此之外，还有一些更高级的用法，例如根据一个 Action 的结果，来触发另一个 Action 的执行。类似于这样的，可以去 Github 的文档中详细了解，这里是传送门。上面介绍的三种方式，在大多数情况下够用了。

在我们今天的例子中，我们希望在提交后触发编译。所以，我们采用第一种：

 
 
 
    
  
  
  
  1. on: 
    2.   
  
  
  2.     push: 
    3.   
  
  
  3.         branches: 
    4.   
  
  
  4.             - main 
    5.

触发器定义完了，下面该定义做什么了。在 Action 中，称为任务 Jobs。

3. 定义任务 Jobs

在规则中，一个触发器，可能对应多个任务，每个任务都需要有一个ID，和一个名称。

 
 
 
    
  
  
  
  1. jobs: 
    2.   
  
  
  2.   first_job: 
    3.   
  
  
  3.     name: First job 
    4.   
  
  
  4.   second_job: 
    5.   
  
  
  5.     name: Second job 
    6.

上面的例子，first_job 是ID，要求是一个词，可以使用下划线。而下面 First job 是名称。跟 Action 的名称一样，可以省略不写。

对于一个任务，下面又需要配置运行环境和步骤。

运行环境，指得是 Action 需要运行的外部操作系统，说白了，是 Github 给提供的虚拟机。当然，我们自己建立 VM 来运行也是可以的，不过通常就使用 Github 托管的VM了。有三种选择：Windows、Ubuntu Linux、macOS。

运行环境，用 runs-on 来标出：

 
 
 
    
  
  
  
  1. jobs: 
    2.   
  
  
  2.   first_job: 
    3.   
  
  
  3.     name: First job 
    4.   
  
  
  4.         runs-on: windows 
    5.

步骤，是定义做这件事需要几个步骤。每个步骤需要单独列出。Action 执行时，会按这个步骤一行一行执行。

直接看例子：

 
 
 
    
  
  
  
  1. steps: 
    2.   
  
  
  2. - uses: actions/checkout@v2 
    3.   
  
  
  3.  
    4.   
  
  
  4. - name: Setup .NET SDK 
    5.   
  
  
  5.     uses: actions/setup-dotnet@v1 
    6.   
  
  
  6.     with: 
    7.   
  
  
  7.         dotnet-version: 5.0.x 
    8.   
  
  
  8.  
    9.   
  
  
  9. - name: Restore 
    10.   
  
  
  10.     run: dotnet restore 
    11.   
  
  
  11.  
    12.   
  
  
  12. - name: Build 
    13.   
  
  
  13.     run: dotnet build --configuration Release --no-restore 
    14.

这是一个简单的步骤例子。

第一步，用了 actions/checkout@v2，这是 GitHub Action 的公共操作，用来签出代码。

第二步，创建编译环境。在 runs-on 给出的 VM 是空的，需要我们自己建立环境。不过不需要像重新安装一个环境那样做。Github 给出了固定的环境创建方法。在这里，我们使用了 actions/setup-dotnet@v1 在环境里配置 Dotnet SDK，并定义了 SDK 的版本是 5.0 。

后面两个步骤，需要在环境中运行命令，所以使用了 run 关键字。这两个步骤，其实就是我们在命令行下生成并编译代码的两个命令。

最后，看一下完整的 Build.yml：

 
 
 
    
  
  
  
  1. name: Sample Build 
    2.   
  
  
  2.  
    3.   
  
  
  3. on: 
    4.   
  
  
  4.     push: 
    5.   
  
  
  5.         branches: 
    6.   
  
  
  6.             - main 
    7.   
  
  
  7. jobs: 
    8.   
  
  
  8.     build: 
    9.   
  
  
  9.  
    10.   
  
  
  10.     runs-on: ubuntu-latest 
    11.   
  
  
  11.  
    12.   
  
  
  12.     steps: 
    13.   
  
  
  13.         - uses: actions/checkout@v2 
    14.   
  
  
  14.  
    15.   
  
  
  15.         - name: Setup .NET SDK 
    16.   
  
  
  16.         uses: actions/setup-dotnet@v1 
    17.   
  
  
  17.         with: 
    18.   
  
  
  18.             dotnet-version: 5.0.x 
    19.   
  
  
  19.  
    20.   
  
  
  20.         - name: Restore 
    21.   
  
  
  21.             run: dotnet restore 
    22.   
  
  
  22.  
    23.   
  
  
  23.         - name: Build 
    24.   
  
  
  24.             run: dotnet build --configuration Release --no-restore 
    25.

三、运行 Action

配置完成，下面就是运行了。

运行是在 Github 上面，当然先要提交代码了。提交到 Github，Action 就会按照我们设定的方式运行了。

本文的代码在：https://github.com/humornif/GithubActionSample

网页题目：我们一起GithubAction入门
路径分享：http://www.shufengxianlan.com/qtweb/news30/102830.html

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

广告

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

猜你还喜欢下面的内容

解决方案知识

各行业网站

宣威网站建设　　 　成都网络公司　　 　培训网站方案　　 　Android开发　　 　达州主机托管　　 　香港虚拟主机　　 　成都网页设计　　 　温江做网站　　 　名片　　 　成都展柜设计　　 　微博营销　　 　app开发公司　　 　成都网站推广　　 　成都营销网站制作　　 　服务器租用　　 　眉山网站建设　　 　手机网站版本　　 　成都画册设计公司　　 　微信小程序开发　　 　网站排名