求Xray Test Runs Summary宏的Confluence正确Wiki标记语法及注意事项

完整可用的Wiki标记语法 #

以下两种写法均可正常渲染，根据习惯选择：

紧凑格式 #

{xray-test-runs-summary:filterId=1234567|groupBy=Test Run Status|layout=chart|chartType=pie|title=Test Progress for Release 1.0|testEnvironments=iOS,Android}

带空格分隔的规范格式 #

{xray-test-runs-summary:filterId=1234567 | groupBy=Test Run Status | layout=chart | chartType=pie | title=Test Progress for Release 1.0 | testEnvironments=iOS,Android}

参数指定方法 #

• filterId：必填，填入Jira筛选器的数字ID，用于限定统计的测试运行范围
• groupBy：可选，设置分组维度，支持Test Run Status、Test Plan、Test Execution等Xray支持的维度
• layout：可选，指定展示样式，可选值为chart（图表）或table（表格）
• chartType：仅在layout=chart时生效，支持pie（饼图）、bar（柱状图）等图表类型
• title：可选，设置宏的展示标题，直接传入文本即可
• testEnvironments：可选，指定要统计的测试环境，多个环境用英文逗号分隔（无空格）

常见使用陷阱 #

• 错误换行：参数后的竖线|不能单独换行，否则Confluence会将整个内容识别为纯文本（这是你之前遇到的核心问题）
• 参数名空格：参数名与等号=之间不能有空格，比如filterId = 1234567是无效写法
• 权限不足：确保当前Confluence用户拥有对应Jira筛选器的访问权限，否则宏会显示权限错误而非渲染失败
• 宏名拼写错误：必须严格使用xray-test-runs-summary，大小写敏感，拼写错误会直接显示纯文本

参数转义规则 #

• 当参数值包含竖线|、逗号,或等号=时，需要用双引号""包裹整个参数值，例如：title="Test Progress: Release 1.0 | Phase 2"
• 如果参数值本身包含双引号，需用反斜杠\转义，例如：title="Test \"Final\" Progress"
• 参数值中的空格可直接使用，无需额外转义

内容的提问来源于stack exchange，提问作者Alex