GitHub Action错误/警告/通知消息中指定参数的作用是什么
GitHub Action 错误/警告附加参数说明
各参数设计用途
GitHub 工作流日志命令中提供的file、line、col等附加参数,核心作用就是将输出的错误、警告信息和仓库内的具体代码位置做绑定:
file:填写问题关联的代码文件相对路径,需使用相对于仓库根目录的路径格式line:填写问题对应的代码行号,仅支持正整数col:填写问题对应代码行的字符列号,仅支持正整数
参数未生效的常见原因
观测不到参数生效大多是触发条件不满足导致的,这类参数仅在符合以下要求时才会被GitHub正常渲染:
仅拉取请求类触发事件(
pull_request、pull_request_target等)支持代码位置标注渲染,push、schedule等其他触发场景下,这类参数不会被解析展示
- 路径填写不能带工作流运行环境的绝对路径前缀,必须直接写仓库内的相对路径,例如不能写
/home/runner/work/repo/repo/src/index.js,需改为src/index.js - 填写的行号、列号不能超过对应文件的实际内容范围,超出范围的参数会被GitHub自动忽略
- 工作流运行时需要有对应版本的代码检出,未执行
actions/checkout的工作流无法完成代码位置关联
生效后的实际体验
参数配置正确的前提下,错误、警告会直接展示在PR的「文件更改」页面对应代码行的位置,和人工代码评审的评论样式一致,参与PR的开发者不需要跳转工作流日志,就能直接看到对应代码的问题提示。
内容的提问来源于stack exchange,提问作者rh0dium
相关产品推荐
相关产品推荐

