Maven: Как проверить, что сгенерированные документы в целевой папке генерируются правильно? - PullRequest
0 голосов
/ 11 октября 2018

У меня есть проект Java / Maven, который использует RestDocs для генерации документации наших конечных точек.

Для непосвященных RestDocs он выполняет мониторинг тестов во время сборки и использует информацию из тестов длягенерировать «фрагменты», которые используются для создания документации API с использованием asciidoc во время фазы пакета mvn.

Проблема, с которой я сталкиваюсь, заключается в том, что если файл asciidoc (.adoc) ссылается на несуществующий фрагмент,Документ генерируется и говорит что-то вроде:

"Неразрешенная директива в myDoc.adoc - include :: {snippets} /error-example/response-fields.adoc []"

С тех порпроизойдет после тестов, я не знаю, как тестировать что-то подобное, чтобы сборка могла остановиться и сообщить разработчику, что ему нужно обновить либо .adoc, либо фрагмент кода.

Любое руководствоочень цениться.

1 Ответ

0 голосов
/ 12 октября 2018

Добавление этого в конфигурацию плагина asciidoctor приводит к сбою сборки, когда не найден фрагмент, который ожидает .adoc:

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