Sync docs from master to gh-pages

2019-09-26 13:59:51 +00:00
parent 72671c6631
commit 9eaf7b0b94
42 changed files with 6169 additions and 5697 deletions
--- a/reference/html/gradle-project.html
+++ b/reference/html/gradle-project.html
@@ -202,15 +202,84 @@ documnetation for more information</a>
 <div class="exampleblock">
 <div class="content">
 <div class="listingblock primary">
-<div class="title">Plugin DSL</div>
+<div class="title">Plugin DSL GA versions</div>
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">buildscript {
+<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">// build.gradle
+plugins {
+  id "groovy"
+  // this will work only for GA versions of Spring Cloud Contract
+  id "org.springframework.cloud.contract" version "${GAVerifierVersion}"
+}
+
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:${GAVerifierVersion}"
+    }
+}
+
+dependencies {
+    testCompile "org.codehaus.groovy:groovy-all:${groovyVersion}"
+    // example with adding Spock core and Spock Spring
+    testCompile "org.spockframework:spock-core:${spockVersion}"
+    testCompile "org.spockframework:spock-spring:${spockVersion}"
+    testCompile 'org.springframework.cloud:spring-cloud-starter-contract-verifier'
+}</code></pre>
+</div>
+</div>
+<div class="listingblock secondary">
+<div class="title">Plugin DSL non GA versions</div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">// settings.gradle
+pluginManagement {
+    plugins {
+        id "org.springframework.cloud.contract" version "${verifierVersion}"
+    }
+    repositories {
+        // to pick from local .m2
+        mavenLocal()
+        // for snapshots
+        maven { url "https://repo.spring.io/snapshot" }
+        // for milestones
+        maven { url "https://repo.spring.io/milestone" }
+        // for GA versions
+        gradlePluginPortal()
+    }
+}
+
+// build.gradle
+plugins {
+  id "groovy"
+  id "org.springframework.cloud.contract"
+}
+
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:${verifierVersion}"
+    }
+}
+
+dependencies {
+    testCompile "org.codehaus.groovy:groovy-all:${groovyVersion}"
+    // example with adding Spock core and Spock Spring
+    testCompile "org.spockframework:spock-core:${spockVersion}"
+    testCompile "org.spockframework:spock-spring:${spockVersion}"
+    testCompile 'org.springframework.cloud:spring-cloud-starter-contract-verifier'
+}</code></pre>
+</div>
+</div>
+<div class="listingblock secondary">
+<div class="title">Legacy Plugin Application</div>
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">// build.gradle
+buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}"
        classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifier_version}"
+        // here you can also pass additional dependencies such as Pact or Kotlin spec e.g.:
+        // classpath "org.springframework.cloud:spring-cloud-contract-spec-kotlin:${verifier_version}"
    }
 }

@@ -232,55 +301,10 @@ dependencies {
 }</code></pre>
 </div>
 </div>
-<div class="listingblock secondary">
-<div class="title">Legacy Plugin Application</div>
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">buildscript {
-    repositories {
-        mavenCentral()
-    }
-    dependencies {
-        classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}"
-    }
-}
-
-apply plugin: 'groovy'
-
-plugins {
-  id "org.springframework.cloud.contract" version "${GAVerifierVersion}"
-}
-
-dependencyManagement {
-    imports {
-        mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:${verifier_version}"
-    }
-}
-
-dependencies {
-    testCompile "org.codehaus.groovy:groovy-all:${groovyVersion}"
-    // example with adding Spock core and Spock Spring
-    testCompile "org.spockframework:spock-core:${spockVersion}"
-    testCompile "org.spockframework:spock-spring:${spockVersion}"
-    testCompile 'org.springframework.cloud:spring-cloud-starter-contract-verifier'
-}</code></pre>
 </div>
 </div>
 </div>
 </div>
-<div class="admonitionblock important">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-important" title="Important"></i>
-</td>
-<td class="content">
-The Plugin DSL option will only work for GA (General Availability) releases (i.e. <code>2.2.0.RELEASE</code> etc.).
-</td>
-</tr>
-</table>
-</div>
-</div>
-</div>
 <div class="sect1">
 <h2 id="gradle-and-rest-assured"><a class="anchor" href="#gradle-and-rest-assured"></a><a class="link" href="#gradle-and-rest-assured">3. Gradle and Rest Assured 2.0</a></h2>
 <div class="sectionbody">
@@ -331,7 +355,28 @@ which are automatically uploaded after every successful build, as the following
 <div class="content">
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">buildscript {
+<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">/*
+ We need to use the [buildscript {}] section when we have to modify
+ the classpath for the plugins. If that's not the case this section
+ can be skipped.
+
+ If you don't need to modify the classpath (e.g. add a Pact dependency),
+ then you can just set the [pluginManagement {}] section in [settings.gradle] file.
+
+ // settings.gradle
+ pluginManagement {
+    repositories {
+        // for snapshots
+        maven {url "https://repo.spring.io/snapshot"}
+        // for milestones
+        maven {url "https://repo.spring.io/milestone"}
+        // for GA versions
+        gradlePluginPortal()
+    }
+ }
+
+ */
+buildscript {
    repositories {
        mavenCentral()
        mavenLocal()
--- a/reference/html/project-features.html
+++ b/reference/html/project-features.html
@@ -2498,6 +2498,18 @@ See the <a href="https://github.com/spring-cloud/spring-cloud-contract/wiki/Spri
 <div class="paragraph">
 <p>For YAML, you can use only the <code>matchers</code> section.</p>
 </div>
+<div class="admonitionblock important">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-important" title="Important"></i>
+</td>
+<td class="content">
+Entries inside the <code>matchers</code> must reference existing elements of the payload. For more information check this <a href="https://github.com/spring-cloud/spring-cloud-contract/issues/722">issue</a>.
+</td>
+</tr>
+</table>
+</div>
 <div class="sect3">
 <h4 id="contract-dsl-dynamic-properties-in-body"><a class="anchor" href="#contract-dsl-dynamic-properties-in-body"></a><a class="link" href="#contract-dsl-dynamic-properties-in-body">2.4.1. Dynamic Properties inside the Body</a></h4>
 <div class="admonitionblock important">
@@ -5769,7 +5781,7 @@ Contract.make {
            header('''Content-Type''', '''application/json;charset=UTF-8''')
            header('''Content-Length''', '''3''')
        }
-        testMatchers {
+        bodyMatchers {
            jsonPath('$[?(@.foo &gt;= 20)]', byType())
        }
    }
@@ -8338,7 +8350,28 @@ versions, which are automatically uploaded after every successful build, as foll
 <div class="listingblock secondary">
 <div class="title">Gradle</div>
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">buildscript {
+<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">/*
+ We need to use the [buildscript {}] section when we have to modify
+ the classpath for the plugins. If that's not the case this section
+ can be skipped.
+
+ If you don't need to modify the classpath (e.g. add a Pact dependency),
+ then you can just set the [pluginManagement {}] section in [settings.gradle] file.
+
+ // settings.gradle
+ pluginManagement {
+    repositories {
+        // for snapshots
+        maven {url "https://repo.spring.io/snapshot"}
+        // for milestones
+        maven {url "https://repo.spring.io/milestone"}
+        // for GA versions
+        gradlePluginPortal()
+    }
+ }
+
+ */
+buildscript {
    repositories {
        mavenCentral()
        mavenLocal()