6 创建第一个工作流之测试工作流

在上一篇教程中，我们深入探讨了如何理解 GitHub Actions 中的 YAML 文件。现在，我们将带着对 YAML 结构的理解，创建我们的第一个 测试工作流。此工作流的目的是在我们每次向仓库推送代码时，自动执行一系列测试。

什么是测试工作流？

测试工作流 是一种自动化流程，它监控特定事件（如代码推送、拉取请求等）并运行预定义的操作。在我们的例子中，这些操作将是运行我们的项目测试，确保代码的正确性和稳定性。

设定工作流

首先，我们需要在项目的根目录下创建一个 .github/workflows 目录（如果还没有的话）。在这个目录中，我们将创建一个名为 test.yml 的文件，这个文件将包含测试工作流的所有定义。

下面是一个基本的 test.yml 文件示例：

name: Test Workflow

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

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14'

    - name: Install dependencies
      run: npm install

    - name: Run tests
      run: npm test

工作流元素分析

• name: Test Workflow：定义了工作流的名称。

• on:：指定了工作流的触发条件。这里我们设置为在 main 分支上的代码推送或拉取请求时触发。

• jobs:：定义了一个或多个工作；每个工作包含一个或多个步骤。

  • test:：定义了我们的第一个工作，名为 test。
  • runs-on: ubuntu-latest：指定该工作将在最新的 Ubuntu 环境中运行。

  接下来是步骤定义：

  • steps:：由一个或多个步骤组成，具体包括：
    • Checkout code：使用 actions/checkout@v2 动作来检出代码。
    • Set up Node.js：设置 Node.js 环境，版本为 14。
    • Install dependencies：运行 npm install 安装依赖。
    • Run tests：运行 npm test 来执行测试。

验证工作流

创建完 test.yml 后，推送代码到 main 分支，您可以在 GitHub 仓库的 Actions 标签页中看到工作流的执行情况。这将帮助您验证工作流的配置是否正确。

如果一切正常，您将在推送完成后看到 Job test succeeded 的消息，表明测试已成功完成。

小结

在本篇中，我们创建了一个简单的 测试工作流，它基于前一篇中理解的 YAML 文件结构。您学会了如何使用 GitHub Actions 自动执行测试，从而使您的开发流程更加高效。接下来，我们将进一步探讨工作流文件的结构，了解其不同组成部分，以便更好地定制和扩展我们的工作流。

请继续关注下一篇教程，我们将为您详细解析工作流的组成部分。