Azure DevOps中sonar-cnes-report自定义模板失效问题求助

检查模板路径与权限 #

• 确认$(configRoot)/templates.docx路径在Azure DevOps流水线中是否正确指向目标模板文件。可在执行生成报告命令前添加dir $(configRoot)指令，验证路径下是否存在该模板。
• 确保流水线执行账号对模板文件拥有读取权限，避免因权限不足导致工具无法读取模板内容。

验证模板格式与占位标记 #

sonar-cnes-report的自定义模板必须包含官方要求的占位标记（如${project.name}、${issues.count}等），工具才会将这些标记替换为SonarQube的实际数据：

• 打开模板文件，确认已添加必要的占位标记，空模板或缺少标记的文件会被直接复制输出。
• 确保模板是可编辑的docx/dotx文件，不要使用受保护、加密或格式损坏的文档。

修正命令参数 #

你的命令中使用-r指定模板，需注意sonar-cnes-report 4.2的参数规则：

• 确保-r指向的是单个模板文件而非目录，若$(configRoot)是目录，路径需精确到具体文件（例如$(configRoot)/custom-report-template.docx）。
• 尝试改用绝对路径，避免相对路径在流水线环境中解析错误，示例命令：

  java -jar $(Build.SourcesDirectory)\sonar-cnes-report\target\sonar-cnes-report-$(CnesVersion).jar -s $(sonarServerURL) -t $(sonarToken) -p $(sonarProjectKey) -r $(Build.SourcesDirectory)\config\templates.docx -o $(Build.ArtifactStagingDirectory)\Sonar-reports
  

查看工具执行日志 #

在流水线中开启详细日志，定位问题根源：

• 执行命令时添加-v（ verbose）参数，输出工具执行的详细过程，查看是否有模板读取失败、标记替换错误等提示：

  java -jar $(Build.SourcesDirectory)\sonar-cnes-report\target\sonar-cnes-report-$(CnesVersion).jar -v -s $(sonarServerURL) -t $(sonarToken) -p $(sonarProjectKey) -r $(configRoot)/templates.docx -o $(Build.ArtifactStagingDirectory)\Sonar-reports
  

• 检查Azure DevOps流水线的日志输出，排查工具执行过程中的异常信息。

验证版本与包完整性 #

• 确认sonar-cnes-report的jar包已正确构建，无损坏。可在本地环境执行相同命令，验证模板是否生效，排除流水线环境的特殊问题。
• 尝试升级到sonar-cnes-report的最新稳定版本，修复可能存在的模板解析bug。

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