25 阅读工作流日志

在前一篇文章中，我们探讨了如何自定义行动，通过编写 JavaScript 行动来扩展 GitHub Actions 的功能。在本篇中，我们将重点关注如何阅读和利用工作流日志，以便更好地调试和优化我们的自动化流程。

一、工作流日志概述

在每次工作流执行时，GitHub Actions 会生成详尽的日志，这些日志记录了工作流的各个阶段和步骤的执行情况。在日志中，我们可以找到有关每一步执行结果的信息，包括错误信息和警告。通过有效地分析这些日志，我们能够快速定位问题，为后续的调试做好准备。

二、访问工作流日志

要查看工作流日志，你可以按照以下步骤进行操作：

1. 登录到你的 GitHub 账号，并进入到相关的代码库。
2. 点击顶部菜单中的“Actions”选项，进入工作流页面。
3. 选择你需要查看的工作流记录，这些记录按照时间顺序排列。
4. 点击某一次工作流的执行记录，你将看到该工作流的详细信息。
5. 在页面的右侧，你会看到各个作业的执行状态，点击某个作业，就能展开查看该作业的详细日志。

三、日志的结构

工作流日志通常会按照以下结构呈现：

• 作业/步骤开始与结束时间：每个作业和步骤的开始和结束时间会显示在日志中，方便你了解整个流程的执行时长。
• 日志输出：这是执行时产生的各种输出信息，包括命令的标准输出（stdout）和错误输出（stderr）。
• 策略信息：如缓存、重试等策略在日志中有详细记录，有助于了解工作流的执行策略。

例子：阅读构建日志

假设我们有一个工作流，它包含编译和测试两个步骤。下面是该工作流的部分日志输出示例：

Run npm install
npm WARN deprecated @types/node@10: @types/node is deprecated. Use @types/node@latest
added 132 packages from 75 contributors and audited 132 packages in 7.223s
found 0 vulnerabilities

从以上日志中，我们可以看到npm install步骤的输出，具体包括了一个警告和包的安装情况。这种信息有助于我们了解依赖管理的状态和可能出现的问题。

四、日志中的关键信息

在查看工作流日志时，有几个关键点需要重点关注：

1. 错误信息：通常以error开头，你需要特别留意这些信息，快速定位问题。
2. 警告信息：警告通常以warning开头，这些并不一定是阻止工作流成功完成的因素，但应该被重视。
3. 步骤输出：每个步骤的输出帮助你确认步骤的执行结果是否符合预期。

例子：故障排除

假设你在工作流中运行测试步骤，但日志中显示“某个测试失败”：

1 failed, 10 passed
Test suite failed to run.

这就提示我们必须去审查该测试用例的代码，进行必要的修复。你也可以结合手动在本地环境中运行这些测试来进行调试。

五、使用日志进行优化

除了故障排除，日志还有助于优化工作流性能。通过对比各个步骤的执行时间，你可以发现哪些步骤耗时过长，并考虑进行优化：

• 并行化作业：将可以并行运行的作业设计为并行执行，可以提高整个工作流的速度。
• 缓存：有效地使用缓存，可以大幅度减少依赖的安装时间。

例子：使用缓存加速工作流

在你的工作流中，可以添加如下步骤来使用缓存：

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Cache npm dependencies
        uses: actions/cache@v2
        with:
          path: ~/.npm
          key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
          
      - name: Install dependencies
        run: npm install

通过这种方式，你可以减少npm install步骤的执行时间，从而提升工作流的执行效率。

六、总结

在 GitHub Actions 中，工作流日志是调试和优化的重要工具。通过仔细分析日志中的每一条信息，我们可以快速定位问题并做出相应的改进。在即将到来的文章中，我们将讨论调试过程中常见的疑难问题，并提供解决方案。希望你在使用 GitHub Actions 的过程中能够合理利用日志，提升工作流的效率。