2.0.9 Release (#405)

* Set version to 2.0.9 * Update documentation * Set latest release to 2.0.9
ScaCap · Aug 10, 2020 · 8244072 · 8244072
1 parent 281abfd
commit 8244072
Show file tree

Hide file tree

Showing 17 changed files with 645 additions and 328 deletions.
diff --git a/README.md b/README.md
@@ -22,14 +22,14 @@ from the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also avail
 
 ## Documentation
 
-[Current 2.0.8 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.8/docs/index.html) reference guide (based on Spring REST Docs 2.x).
+[Current 2.0.9 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.9/docs/index.html) reference guide (based on Spring REST Docs 2.x).
 
 [Current 1.0.15 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.15/docs/index.html) reference guide (based on Spring REST Docs 1.x).
 
-Latest master [2.0.8](https://scacap.github.io/spring-auto-restdocs) reference guide.
+Latest master [2.0.9](https://scacap.github.io/spring-auto-restdocs) reference guide.
 
 Older releases:
-[2.0.7](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.7/docs/index.html),
+[2.0.8](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.8/docs/index.html),
 [1.0.14](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.14/docs/index.html)
 
 ## Main features

diff --git a/docs/index.html b/docs/index.html
@@ -437,7 +437,7 @@
 <h1>Spring Auto REST Docs</h1>
 <div class="details">
 <span id="author" class="author">Scalable Capital</span><br>
-<span id="revnumber">version 2.0.9-SNAPSHOT</span>
+<span id="revnumber">version 2.0.9</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -496,6 +496,7 @@ <h1>Spring Auto REST Docs</h1>
 </li>
 <li><a href="#contributing">Contributing</a>
 <ul class="sectlevel2">
+<li><a href="#contributing-pr">Pull Requests</a></li>
 <li><a href="#contributing-building">Building from source</a></li>
 </ul>
 </li>
@@ -605,6 +606,10 @@ <h2 id="faq"><a class="link" href="#faq">FAQ</a></h2>
 <p><em>Is HATEOAS supported?</em></p>
 <p>Yes, there is basic support for <a href="#snippets-links">links</a> and <a href="#snippets-embedded">embedded</a> resources.</p>
 </li>
+<li>
+<p><em>What should I do if I get a <code>NoSuchBeanDefinitionException: No bean named 'webHandler' available</code> exception?</em></p>
+<p>This means that the servlet stack instead if the reactive one is active. Make sure that <code>@EnableWebFlux</code> is used.</p>
+</li>
 </ol>
 </div>
 </div>
@@ -620,7 +625,7 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
 <div class="ulist">
 <ul>
 <li>
-<p>Java 8 or Kotlin 1.2</p>
+<p>Java 8 or Kotlin 1.3</p>
 </li>
 <li>
 <p>Spring REST Docs 2.0.4.RELEASE (see <a href="http://docs.spring.io/spring-restdocs/docs/2.0.4.RELEASE/reference/html5/">documentation</a>)</p>
@@ -635,7 +640,9 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
 please use the 1.0.x version of Spring Auto REST Docs.</p>
 </div>
 <div class="paragraph">
-<p>For Java 9/10/11 support, use <code>spring-auto-restdocs-json-doclet-jdk9</code> as doclet dependency.</p>
+<p>For Java 9+ support, use <code>spring-auto-restdocs-json-doclet-jdk9</code> as doclet dependency.
+Our support is focused on the latest Kotlin version, Java 8 and 11.
+In addition, we try to support the latest Java version that is supported by Spring.</p>
 </div>
 </div>
 <div class="sect2">
@@ -653,7 +660,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
 <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
     &lt;groupId&gt;capital.scalable&lt;/groupId&gt;
     &lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
-    &lt;version&gt;2.0.8&lt;/version&gt;
+    &lt;version&gt;2.0.9&lt;/version&gt;
     &lt;scope&gt;test&lt;/scope&gt;
 &lt;/dependency&gt;
 
@@ -690,7 +697,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
                         &lt;docletArtifact&gt;
                             &lt;groupId&gt;capital.scalable&lt;/groupId&gt;
                             &lt;artifactId&gt;spring-auto-restdocs-json-doclet&lt;/artifactId&gt; <i class="conum" data-value="3"></i><b>(3)</b>
-                            &lt;version&gt;2.0.8&lt;/version&gt;
+                            &lt;version&gt;2.0.9&lt;/version&gt;
                         &lt;/docletArtifact&gt;
                         &lt;destDir&gt;generated-javadoc-json&lt;/destDir&gt; <i class="conum" data-value="2"></i><b>(2)</b>
                         &lt;reportOutputDirectory&gt;${project.build.directory}&lt;/reportOutputDirectory&gt; <i class="conum" data-value="2"></i><b>(2)</b>
@@ -735,8 +742,8 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
 }
 
 dependencies {
-    testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.8'
-    jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.8' <i class="conum" data-value="3"></i><b>(3)</b>
+    testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.9'
+    jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.9' <i class="conum" data-value="3"></i><b>(3)</b>
 }
 
 task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1366,7 +1373,9 @@ <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snipp
 
 ==== {{header}}
 
-include::{{fileName}}.adoc[]
+{{#filenames}}
+include::{{.}}.adoc[]
+{{/filenames}}
 {{/sections}}</code></pre>
 </div>
 </div>
@@ -1795,7 +1804,9 @@ <h3 id="snippets-section"><a class="link" href="#snippets-section">Section snipp
 
 ==== {{header}}
 
-include::{{fileName}}.adoc[]
+{{#filenames}}
+include::{{.}}.adoc[]
+{{/filenames}}
 {{/sections}}</code></pre>
 </div>
 </div>
@@ -2436,13 +2447,19 @@ <h3 id="integrations-wiremock"><a class="link" href="#integrations-wiremock">Wir
 <h2 id="contributing"><a class="link" href="#contributing">Contributing</a></h2>
 <div class="sectionbody">
 <div class="sect2">
+<h3 id="contributing-pr"><a class="link" href="#contributing-pr">Pull Requests</a></h3>
+<div class="paragraph">
+<p>For code formatting please use <a href="https://github.com/ScaCap/spring-auto-restdocs/blob/master/intellij-codestyle.xml">intellij-codestyle.xml</a>.</p>
+</div>
+</div>
+<div class="sect2">
 <h3 id="contributing-building"><a class="link" href="#contributing-building">Building from source</a></h3>
 <div class="sect3">
-<h4 id="contributing-installing-testjar"><a class="link" href="#contributing-installing-testjar">Install Spring REST Docs test JAR</a></h4>
+<h4 id="contributing-installing-restdocs-testjar"><a class="link" href="#contributing-installing-restdocs-testjar">Install Spring REST Docs test JAR</a></h4>
 <div class="paragraph">
 <p>The Spring REST Docs test JAR is not published via Maven, but this project relies on it.
 If you want to build this project yourself, you need to install the test JAR.
-The test JAR is located in the lib folder and can be installed as follow:</p>
+The test JAR is located in the lib folder and can be installed as follows:</p>
 </div>
 <div class="listingblock">
 <div class="title">Bash</div>
@@ -2454,7 +2471,23 @@ <h4 id="contributing-installing-testjar"><a class="link" href="#contributing-ins
 </div>
 </div>
 <div class="sect3">
-<h4 id="contributing-building-testjar"><a class="link" href="#contributing-building-testjar">Build Spring REST Docs test JAR</a></h4>
+<h4 id="contributing-installing-dokka-testjar"><a class="link" href="#contributing-installing-dokka-testjar">Install Dokka Core test JAR</a></h4>
+<div class="paragraph">
+<p>Dokka publishes no test JAR, but the Spring Auto REST Docs Dokka extension uses their test utilities.
+If you want to build this project yourself, you need to install the test JAR.
+The test JAR is located in the lib folder and can be installed as follows:</p>
+</div>
+<div class="listingblock">
+<div class="title">Bash</div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">mvn install:install-file -Dfile=lib/dokka-core-0.10.1-tests.jar \
+     -DgroupId=org.jetbrains.dokka -DartifactId=dokka-core -Dversion=0.10.1 \
+     -Dpackaging=jar -Dclassifier=test</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="contributing-building-restdocs-testjar"><a class="link" href="#contributing-building-restdocs-testjar">Build Spring REST Docs test JAR</a></h4>
 <div class="paragraph">
 <p>Building the Spring REST Docs test JAR is not required to build the project,
 but if you ever want to upgrade the version of Spring REST Docs in this project this step has to be done.</p>
@@ -2497,6 +2530,56 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
 </div>
 </div>
 <div class="sect3">
+<h4 id="contributing-building-dokka-testjar"><a class="link" href="#contributing-building-dokka-testjar">Build Dokka Core test JAR</a></h4>
+<div class="paragraph">
+<p>Building the Dokka core test JAR is not required to build the project,
+but if you ever want to upgrade the version of Dokka in this project this step has to be done.</p>
+</div>
+<div class="paragraph">
+<p>We use version 0.10.1 of Dokka in this example.</p>
+</div>
+<div class="paragraph">
+<p>Clone and checkout a specific version of Dokka:</p>
+</div>
+<div class="listingblock">
+<div class="title">Bash</div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone git@github.com:Kotlin/dokka.git
+cd dokka
+git checkout 0.10.1</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Add the following snippet at the end of <code>core/build.gradle</code>:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">task testJar(type: Jar) {
+    classifier = 'tests'
+    from sourceSets.test.output
+}</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>To speed the build up and avoid test issues, once can reduce the list of sub-projects in
+<code>settings.gradle</code> to just <code>core</code> and <code>integration</code>.</p>
+</div>
+<div class="paragraph">
+<p>Make sure to use JDK 8 for the build.
+Create the test JAR by running the following command on the top-level:</p>
+</div>
+<div class="listingblock">
+<div class="title">Bash</div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">./gradlew testJar</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Afterwards the test JAR is located at
+<code>core/build/libs/core-0.10.1-SNAPSHOT-tests.jar</code></p>
+</div>
+</div>
+<div class="sect3">
 <h4 id="contributing-building-build"><a class="link" href="#contributing-building-build">Build</a></h4>
 <div class="listingblock">
 <div class="title">Bash (in root folder)</div>
@@ -2511,8 +2594,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
 </div>
 <div id="footer">
 <div id="footer-text">
-Version 2.0.9-SNAPSHOT<br>
-Last updated 2020-03-29 23:43:30 +0200
+Version 2.0.9<br>
+Last updated 2020-08-10 10:13:23 +0200
 </div>
 </div>
 <link rel="stylesheet" href="highlight/styles/github.min.css">

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-parent</artifactId>
-    <version>2.0.9-SNAPSHOT</version>
+    <version>2.0.9</version>
     <packaging>pom</packaging>
 
     <name>Spring Auto REST Docs Parent POM</name>

diff --git a/samples/java-webflux/pom.xml b/samples/java-webflux/pom.xml
@@ -13,7 +13,7 @@
 
     <groupId>capital.scalable</groupId>
     <artifactId>spring-auto-restdocs-java-webflux-example</artifactId>
-    <version>2.0.9-SNAPSHOT</version>
+    <version>2.0.9</version>
 
     <name>Spring Auto REST Docs Java WebFlux Example Project</name>
     <description>Example project for Spring Auto REST Docs</description>
@@ -35,7 +35,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <start-class>capital.scalable.restdocs.example.Application</start-class>
         <spring-restdocs.version>2.0.4.RELEASE</spring-restdocs.version>
-        <spring-auto-restdocs.version>2.0.9-SNAPSHOT</spring-auto-restdocs.version>
+        <spring-auto-restdocs.version>2.0.9</spring-auto-restdocs.version>
     </properties>
 
     <dependencies>

diff --git a/samples/java-webmvc/build.gradle b/samples/java-webmvc/build.gradle
@@ -1,6 +1,6 @@
 buildscript {
     ext {
-        springAutoRestDocsVersion = "2.0.9-SNAPSHOT"
+        springAutoRestDocsVersion = "2.0.9"
         springRestDocsVersion = "2.0.4.RELEASE"
         springBootVersion = "2.3.0.RELEASE"
     }
@@ -20,7 +20,7 @@ apply plugin: "io.spring.dependency-management"
 apply plugin: "org.asciidoctor.convert"
 
 group = "capital.scalable"
-version = "2.0.9-SNAPSHOT"
+version = "2.0.9"
 
 description = """Spring Auto REST Docs Java Web MVC Example Project"""