Skip to content

Project templating requirements

Jump to bottom
Andy Wilkinson edited this page Apr 10, 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 dependency on org.codehaus.groovy:groovy when initialising a Groovy project
  • Add a dependency on org.jetbrains.kotlin:kotlin-reflect when initialising a Kotlin project
  • Add a dependency on org.jetbrains.kotlin:kotlin-stdlib when building a Kotlin project on Java 6
  • Add a dependency on org.jetbrains.kotlin:kotlin-stdlib-jdk7 when building a Kotlin project on Java 7
  • Add a dependency on org.jetbrains.kotlin:kotlin-stdlib-jdk8 when building a Kotlin project on Java 8 or later
  • Add a dependency on org.springframework.boot:spring-boot-starter-test to all projects

Add a plugin

  • Add the Asciidoctor plugin to Spring REST Docs projects
  • Add org.codehaus.gmavenplus:gmavenplus-plugin to Groovy projects
  • Add org.jetbrains.kotlin:kotlin-maven-plugin to Kotlin projects

Configure a plugin execution

  • Generate documentation during the prepare-package phase in Spring REST Docs projects
  • Configure GMaven+ executions when initialising a Groovy project
  • Configure Kotlin Maven Plugin executions when initialising a Groovy project

Configure a plugin dependency

  • Add a dependency on spring-restdocs-asciidoctor to the Asciidoctor plugin in Spring REST Docs projects
  • Add a dependency on org.jetbrains.kotlin:kotlin-maven-allopen to the Kotlin Maven plugin in Kotlin projects

Configure a repository

Configure a plugin repository

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
  • Apply org.jetbrains.kotlin:kotlin-gradle-plugin and org.jetbrains.kotlin:kotlin-allopen when initialising a Kotlin project

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

Add a repository

Add a buildscript repository

Clone this wiki locally