Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

新增 -gm/--generate-metadata [directory] 选项,用于在指定目录下生成汇总的元数据与特定目录结构 #50

Open
255doesnotexist opened this issue Dec 10, 2024 · 7 comments
Assignees
Labels
enhancement New feature or request

Comments

@255doesnotexist
Copy link
Owner

新增 -gm/--generate-metadata [target_directory] 选项,用于在指定目录下生成汇总的元数据与特定目录结构。
target_directory 可选。如留空默认为 cwd。

对于每一个 $distro$target_directory/$distro_mapped/README.md 中生成带元信息头的简要、人类易于理解的测试报告(英文优先,i18n 后续实现再考虑),如合适,应附带必要的启动 log、各测试的 log。

$distro_mapped 也通过配置文件配置一个映射,保证其目录名与 support-matrix 中使用的目录同步。

元信息头格式如下

---
sys: $distro_metaname (通过配置文件的映射与 support-matrix 中使用的名称同步)
sys_ver: null (暂不清楚不指定为 null 是否会影响 support-matrix 中 ci 运行,如不会则可能输出为 uname -a 提取的系统版本号)
sys_var: null

status: basic (如能通过 qemu 启动应该都算 basic 支持不包括图形化, 或者沟通后给一个新状态也可)
last_update: 2024-09-26 (自动化测试日期)
---

..后续防止易于理解的测试报告内容...

此外,还需在 $target_directory 中生成一 others.yml。可以直接从配置好的固有文件拷贝内容,或在其上追加自动化测试完全失败(QEMU 环境异常没拉起来)的发行版信息(也许不要追加才会好,如果这次失败了沿用上一次的结果先调试着不要污染支持矩阵结果)。

others.yml 结构类似:

- sys: rtthread
  sys_ver: null
  sys_var: null
  status: cft
- sys: openharmony
  sys_ver: null
  sys_var: null
  status: cft
@255doesnotexist 255doesnotexist added the enhancement New feature or request label Dec 10, 2024
@255doesnotexist 255doesnotexist self-assigned this Dec 10, 2024
@aisuneko
Copy link
Collaborator

pls define "易于理解的测试报告内容"

@255doesnotexist
Copy link
Owner Author

255doesnotexist commented Dec 10, 2024

pls define "易于理解的测试报告内容"

测试报告内容:如目标是合入 support-matrix,内容及格式应当与原仓库 README.md 格式接近。例子?

可以针对每一种 distro 提供一个 Markdown 模板,在其中留下方便程序替换的 placeholder 指示此处应替换为启动日志 {boot_log} 或各测试项目结果表单 {test_results_table},由程序填入后再输出。一般不要硬编码。其他与测试结果相关性不大部分如 ## Installation Steps 可以保留模板的内容,如此处应当是如何配置该 distro 的 QEMU VM 的具体步骤。

@aisuneko
Copy link
Collaborator

pls define "易于理解的测试报告内容"

测试报告内容:如目标是合入 support-matrix,内容及格式应当与原仓库 README.md 格式接近。例子?

可以针对每一种 distro 提供一个 Markdown 模板,在其中留下方便程序替换的 placeholder 指示此处应替换为启动日志 {boot_log} 或各测试项目结果表单 {test_results_table},由程序填入后再输出。一般不要硬编码。其他与测试结果相关性不大部分如 ## Installation Steps 可以保留模板的内容,如此处应当是如何配置该 distro 的 QEMU VM 的具体步骤。

不是 @wychlw 已经做了适用于 support-matrix 那种场景的脚本么 感觉这个功能暂时不在我们的考虑范围内

@255doesnotexist
Copy link
Owner Author

pls define "易于理解的测试报告内容"

测试报告内容:如目标是合入 support-matrix,内容及格式应当与原仓库 README.md 格式接近。例子?
可以针对每一种 distro 提供一个 Markdown 模板,在其中留下方便程序替换的 placeholder 指示此处应替换为启动日志 {boot_log} 或各测试项目结果表单 {test_results_table},由程序填入后再输出。一般不要硬编码。其他与测试结果相关性不大部分如 ## Installation Steps 可以保留模板的内容,如此处应当是如何配置该 distro 的 QEMU VM 的具体步骤。

不是 @wychlw 已经做了适用于 support-matrix 那种场景的脚本么 感觉这个功能暂时不在我们的考虑范围内

那个脚本能在这里复用吗?

@aisuneko
Copy link
Collaborator

emm我的意思是我们这个项目应该跟这个需求无关(
需要往markdown里塞元数据的话也是 support-matrix 那边的事情?

@255doesnotexist
Copy link
Owner Author

emm我的意思是我们这个项目应该跟这个需求无关( 需要往markdown里塞元数据的话也是 support-matrix 那边的事情?

所以我们直接 pr 提交 summary.md 给 support-matrix/qemu/README.md,然后是会有一个自动脚本帮忙生成元数据吗...?

@wychlw
Copy link

wychlw commented Dec 12, 2024

如果要将软件包测试结果加入到支持矩阵里,可能需要对现有程序进行一些扩展(比如很显然软件哪来的CPU字段,但该字段目前为必选)
我们可能需要找个时间商量下metadata需要些什么,及表格/项目结构如何设计

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants