更新日志

[3.1.0] - 2025-12-22

🎯 重要变更：默认不生成截图列

行为变更

  • 默认不生成截图列：Excel 表格更简洁，列数更少（7 列而非 8 列）
  • 新增参数 --with-screenshots：需要截图列时添加此参数

原因

  • 大多数使用场景只需要步骤清单
  • 减小文件大小，提升生成速度
  • 打印输出更方便
  • 更适合快速分享和协作

使用示例

# 默认行为（不包含截图列）
python generate_excel.py -m sop-101-policy-label-create.md

# 包含截图列
python generate_excel.py \
  -m sop-101-policy-label-create.md \
  --with-screenshots

迁移说明

如果您需要保持之前的行为（包含截图列），请在命令中添加 --with-screenshots 参数。

[3.0.0] - 2025-12-22

🚀 重大更新：Markdown 自动解析

核心新功能

  • Markdown 文件自动解析：支持从 SOP markdown 文档中自动提取任务表格数据
  • 完全自动化：无需手动维护 Excel 生成脚本中的数据，直接从文档生成报告
  • 智能识别：自动识别任务标题、前置条件、表格数据和任务编号
  • 灵活兼容：支持任意数量的任务和步骤，不限于预定义的 4 个任务

新增参数

  • --markdown / -m：指定输入的 markdown 文件路径

Markdown 解析特性

  1. 任务识别：自动识别 ### 任务 T{编号}：{标题} 格式的任务
  2. 表格解析：自动解析 markdown 表格，提取所有列数据
  3. 格式清理：自动移除 markdown 代码标记（`）和多余格式
  4. 路径生成：自动生成规范的截图文件路径
  5. 调试模式：内置调试输出，显示解析过程

使用示例

# 从 markdown 自动生成 Excel
python generate_excel.py --markdown sop-003-product-creation-e2e.md

# 组合参数使用
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  -o "产品测试报告" \
  -u "https://test.example.com/crm"

[2.0.0] - 2025-12-22

✨ 重大更新：参数化配置

新增功能

  • 命令行参数支持：脚本现在支持通过命令行参数自定义所有配置，不再依赖硬编码常量
  • 灵活的配置选项：可以通过参数调整输出文件名、URL、截图目录、样式等所有设置
  • 简写参数：常用参数提供了简短的别名（如 -o, -u, -s）
  • 帮助文档：通过 --help 查看完整的参数说明和使用示例

参数化的配置项

  1. 基础配置
  2. --output-prefix / -o：输出文件名前缀
  3. --base-url / -u：测试系统的基础 URL

  4. --screenshot-dir / -s：截图存放目录

  5. 样式配置

  6. --header-color：表头背景色
  7. --title-font-size：标题字体大小

  8. --checkbox-font-size：复选框字体大小

  9. 图片配置

  10. --image-scale-x：图片横向缩放比例
  11. --image-scale-y：图片纵向缩放比例
  12. --row-height：包含图片的行高

代码改进

  • 重构 create_excel_with_checkboxes() 函数，添加参数支持
  • 新增 parse_arguments() 函数处理命令行参数
  • 使用 argparse 模块提供完善的参数解析和帮助信息
  • 所有硬编码的常量都已替换为参数或配置项

文档更新

  • 新增 USAGE.md：详细的使用说明文档
  • 更新 README.md：添加 Excel 生成工具的说明
  • 新增 examples.sh：提供 7 个实用的使用示例
  • 新增 CHANGELOG.md：记录版本更新历史

向后兼容

  • 所有参数都有默认值，保持与原有功能的兼容性
  • 不带参数运行时行为与之前版本完全一致

🎯 使用示例

# 使用默认参数（与之前版本行为一致）
python generate_excel.py

# 自定义输出文件名
python generate_excel.py --output-prefix "UAT测试报告"

# 指定测试环境 URL
python generate_excel.py --base-url "https://uat.example.com/crm"

# 组合多个参数
python generate_excel.py \
  -o "生产环境测试" \
  -u "https://prod.example.com/crm" \
  -s "prod_screenshots" \
  --header-color "#2E7D32"

📚 相关文档

[1.0.0] - 2025-12-20

初始版本

  • 基本的 Excel 生成功能
  • 支持复选框（自定义数字格式）
  • 支持超链接跳转
  • 支持截图自动嵌入
  • 硬编码配置常量