[action][cppcheck] add summary (#9426)
* [action][cppcheck] add summary 添加summary 方便查看出错信息
This commit is contained in:
parent
c154c24319
commit
a0e1f954c8
|
@ -27,7 +27,7 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v3
|
uses: actions/setup-python@main
|
||||||
with:
|
with:
|
||||||
python-version: 3.8
|
python-version: 3.8
|
||||||
|
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
# Change Logs:
|
# Change Logs:
|
||||||
# Date Author Notes
|
# Date Author Notes
|
||||||
# 2023-05-16 dejavudwh the first version
|
# 2023-05-16 dejavudwh the first version
|
||||||
|
# 2024-09-12 supperthomas add cppcheck summary for detail
|
||||||
#
|
#
|
||||||
|
|
||||||
import click
|
import click
|
||||||
|
@ -13,7 +14,35 @@ import logging
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
import format_ignore
|
import format_ignore
|
||||||
|
import os
|
||||||
|
'''
|
||||||
|
--suppress=syntaxError:
|
||||||
|
该选项用于抑制特定的错误类型。在这里,syntaxError 是被忽略的错误类型。这意味着 Cppcheck 不会报告语法错误(syntaxError)。这是因为在某些情况下,分析工具可能会误报语法错误,但 CI(持续集成)系统会在编译时捕获这些错误,因此可以忽略。
|
||||||
|
|
||||||
|
--enable=warning:
|
||||||
|
该选项用于启用特定类型的检查。Cppcheck 可以检查不同的级别和种类的问题,如错误、警告、性能问题等。--enable=warning 启用的是警告级别的检查,帮助检测代码中可能存在的问题,但不是严重的错误。
|
||||||
|
|
||||||
|
performance:
|
||||||
|
Cppcheck 可以启用多个检查种类,在这里指定了 performance,意味着会检查与代码性能相关的潜在问题,例如不必要的拷贝操作、无效的条件判断等。这有助于提高代码的运行效率。
|
||||||
|
|
||||||
|
portability:
|
||||||
|
Cppcheck 会检查代码的可移植性问题。可移植性检查帮助发现代码在不同平台或编译器中可能遇到的问题,如特定平台上不支持的类型、函数或特性。这对跨平台开发非常重要。
|
||||||
|
|
||||||
|
--inline-suppr:
|
||||||
|
该选项允许在代码中使用注释来抑制特定的警告或错误信息。通过这种方式,开发者可以直接在代码中添加注释,告诉 Cppcheck 忽略某些检查或警告。例如,开发者可以在代码中添加 // cppcheck-suppress <message> 来抑制特定的警告信息。
|
||||||
|
|
||||||
|
--error-exitcode=1:
|
||||||
|
该选项告诉 Cppcheck 如果遇到错误,就返回指定的退出码。在这里指定的是 1。这对自动化工具非常有用,尤其是在 CI 环境中,因为它可以通过检查返回码来判断 Cppcheck 是否发现了错误。如果有错误,CI 系统会将整个任务标记为失败。
|
||||||
|
|
||||||
|
--force:
|
||||||
|
这个选项强制 Cppcheck 对所有文件进行检查,即使它检测到编译条件缺失或某些配置问题。通常,如果某些宏定义或依赖项缺失,Cppcheck 可能会跳过某些文件的检查。但 --force 会强制工具继续执行分析,即使有可能缺少某些信息。这在某些大型项目中很有用,可以确保所有文件都经过检查。
|
||||||
|
'''
|
||||||
|
def add_summary(text):
|
||||||
|
"""
|
||||||
|
add summary to github action.
|
||||||
|
"""
|
||||||
|
os.system(f'echo "{text}" >> $GITHUB_STEP_SUMMARY ;')
|
||||||
|
|
||||||
class CPPCheck:
|
class CPPCheck:
|
||||||
def __init__(self, file_list):
|
def __init__(self, file_list):
|
||||||
self.file_list = file_list
|
self.file_list = file_list
|
||||||
|
@ -46,6 +75,9 @@ class CPPCheck:
|
||||||
logging.info(result.stdout.decode())
|
logging.info(result.stdout.decode())
|
||||||
logging.info(result.stderr.decode())
|
logging.info(result.stderr.decode())
|
||||||
if result.stderr:
|
if result.stderr:
|
||||||
|
add_summary("The following errors are for reference only. If they are not actual issues, please ignore them and do not make unnecessary modifications.")
|
||||||
|
add_summary("以下错误仅供参考,如果发现没有问题,请直接忽略,不需要强行修改")
|
||||||
|
add_summary(f"- :rotating_light: {result.stderr.decode()}")
|
||||||
check_result = False
|
check_result = False
|
||||||
return check_result
|
return check_result
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue