深入理解Actions Toolkit中的Problem Matchers机制-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01050/article/details/148505752

深入理解Actions Toolkit中的Problem Matchers机制

toolkit The GitHub ToolKit for developing GitHub Actions. 项目地址: https://gitcode.com/gh_mirrors/to/toolkit

什么是Problem Matchers

Problem Matchers是Actions Toolkit中一个强大的日志分析工具，它允许开发者通过定义正则表达式模式来扫描操作输出中的特定信息，并将这些信息突出显示在用户界面中。当检测到匹配项时，系统会自动创建注释和日志文件标记，帮助开发者快速定位问题。

核心工作机制

Problem Matchers的工作原理可以分为以下几个关键步骤：

模式匹配：通过预定义的正则表达式模式扫描操作输出
信息提取：从匹配的文本中提取关键信息（如文件名、行号、错误信息等）
注释生成：将提取的信息转换为可视化的注释标记
界面展示：在用户界面中突出显示问题位置

使用限制与最佳实践

在实际使用中，Problem Matchers存在一些配额限制：

每个步骤最多允许10个警告注释、10个错误注释和10个通知注释
每个作业总共允许50个注释（所有步骤注释的总和）
每个运行过程允许50个系统级注释

应对策略：当预期会超出这些限制时，建议对日志消息进行筛选，例如只关注与当前PR相关的文件修改部分，或者根据特定条件过滤日志消息。

单行匹配器配置详解

让我们以ESLint的紧凑输出格式为例：

badFile.js: line 50, col 11, Error - 'myVar' is defined but never used. (no-unused-vars)

对应的Problem Matcher配置如下：

{
    "problemMatcher": [
        {
            "owner": "eslint-compact",
            "pattern": [
                {
                    "regexp": "^(.+):\\sline\\s(\\d+),\\scol\\s(\\d+),\\s(Error|Warning|Info)\\s-\\s(.+)\\s\\((.+)\\)$",
                    "file": 1,
                    "line": 2,
                    "column": 3,
                    "severity": 4,
                    "message": 5,
                    "code": 6
                }
            ]
        }
    ]
}

配置字段说明

owner：必填字段，用于标识问题匹配器，可用于移除或替换
severity：默认严重级别，可选'warning'或'error'（不区分大小写），默认为'error'
pattern：匹配模式数组，每个模式对象包含：
- regexp：必填，提供匹配组的正则表达式模式
- file：包含文件名的组号
- fromPath：包含文件路径的组号（用于根目录定位）
- line：包含行号的组号
- column：包含列信息的组号
- severity：包含严重级别的组号
- code：包含错误代码的组号
- message：必填（至少一个模式必须设置），包含错误信息的组号
- loop：是否循环直到找不到匹配，仅对多行匹配器的最后一个模式有效

多行匹配器高级用法

考虑以下输出格式：

test.js
  1:0   error  Missing "use strict" statement                 strict
  5:10  error  'addOne' is defined but never used             no-unused-vars
✖ 2 problems (2 errors, 0 warnings)

这种情况下，文件名只出现一次，但包含多个错误行。使用loop关键字可以处理这种输出格式：

{
    "problemMatcher": [
        {
            "owner": "eslint-stylish",
            "pattern": [
                {
                    "regexp": "^([^\\s].*)$",
                    "file": 1
                },
                {
                    "regexp": "^\\s+(\\d+):(\\d+)\\s+(error|warning|info)\\s+(.*)\\s\\s+(.*)$",
                    "line": 1,
                    "column": 2,
                    "severity": 3,
                    "message": 4,
                    "code": 5,
                    "loop": true
                }
            ]
        }
    ]
}

工作流程：