Maven:如何测试目标文件夹中生成的文档是否正确生成？

Question

我有一个使用 RestDocs 生成端点文档的 Java/Maven 项目。

对于不了解 RestDocs 的人来说，它所做的是在构建期间监视测试并使用来自测试的信息生成“片段”，这些片段用于在 mvn 包阶段使用 asciidoc 创建 API 文档。

我面临的问题是，如果 asciidoc (.adoc) 文件引用了一个不存在的代码段，则会生成该文档并显示如下内容:

“myDoc.adoc 中 Unresolved 指令 - include::{snippets}/error-example/response-fields.adoc[]”

由于这发生在测试之后，我不知道如何测试这样的东西，以便构建可以停止并让开发人员知道他们需要更新 .adoc 或代码段。

任何指导将不胜感激。

Answer 1

当找不到 .adoc 期望的片段时，将此添加到 asciidoctor 插件的配置会导致构建失败:

<logHandler>
     <outputToConsole>true</outputToConsole>
          <failIf>
              <containsText>include file not found</containsText>
          </failIf>
</logHandler>