Skip to content

Project templating requirements

Andy Wilkinson edited this page Apr 9, 2018 · 5 revisions

Groovy

Add an annotation to the main class

  • Various @Enable… annotations

Java

Add an annotation to the main class

  • Various @Enable… annotations

Kotlin

Add an annotation to the main class

  • Various @Enable… annotations

Maven

Add a dependency

  • Add a dependency with the appropriate scope when a checkbox is selected

Add a plugin

  • Add the Asciidoctor plugin to Spring REST Docs projects

Configure a plugin execution

  • Generate documentation during the prepare-package phase in Spring REST Docs projects

Configure a plugin dependency

  • Add a dependency on spring-restdocs-asciidoctor in Spring REST Docs projects

Gradle

Add a dependency

  • Add a dependency to the appropriate configuration when a checkbox is selected

Apply a plugin

  • Apply the Asciidoctor plugin to Spring REST Docs projects

Configure a task

  • Configure the asciidoctor task to depend on the test task in Spring REST Docs projects
  • Configure the asciidoctor task to use the snippets directory as an input in Spring REST Docs projects
  • Configure the test task to declare the snippets directory as an output in Spring REST Docs projects