SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
buildmaster
2019-08-09 21:57:21 +00:00
parent e23a7bf12f
commit 01a2aafb14
70 changed files with 3875 additions and 3450 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
reference/htmlsingle/index.html
View File

@@ -444,6 +444,7 @@ $(addBlockSwitches);
<li><a href="#how-to-use-stubs-from-a-location">5.15. How can I Use Stubs from a Location</a></li>
<li><a href="#how-to-generate-stubs-at-runtime">5.16. How can I Generate Stubs at Runtime</a></li>
<li><a href="#how-to-use-the-failonnostubs-feature">5.17. How can I Make The Build Pass if There Are No Contracts or Stubs</a></li>
<li><a href="#how-to-mark-contract-in-progress">5.18. How can I Mark that a Contract Is in Progress</a></li>
</ul>
</li>
</ul>
@@ -4406,6 +4407,9 @@ example shows how to do so:</p>
</div>
</div>
</div>
<div class="paragraph">
<p>You can set the value of the <code>failOnInProgress</code> Spring Cloud Contract plugin property to ensure that your build will break when at least one contract in progress remains in your sources.</p>
</div>
</div>
<div class="sect4">
<h5 id="contract-dsl-passing-values-from-files"><a class="anchor" href="#contract-dsl-passing-values-from-files"></a><a class="link" href="#contract-dsl-passing-values-from-files">Passing Values from Files</a></h5>
@@ -14899,6 +14903,15 @@ You need not specify the output directory for the generated snippets (since vers
<p>If you want the plugins not to fail the build when no contracts were found, you can set the <code>failOnNoStubs</code> flag in Maven or call the <code>contractRepository { failOnNoStubs(false) }</code> Closure in Gradle.</p>
</div>
</div>
<div class="sect2">
<h3 id="how-to-mark-contract-in-progress"><a class="anchor" href="#how-to-mark-contract-in-progress"></a><a class="link" href="#how-to-mark-contract-in-progress">5.18. How can I Mark that a Contract Is in Progress</a></h3>
<div class="paragraph">
<p>If a contract is in progress, it means that the on the producer side tests will not be generated, but the stub will be. You can read more about this in <a href="#contract-dsl-in-progress">this section</a> of the documentation.</p>
</div>
<div class="paragraph">
<p>In a CI build, before going to production, you would like to ensure that no in progress contracts are there on the classpath. That&#8217;s because you may lead to false positives. That&#8217;s why, by default, in the Spring Cloud Contract plugin, we set the value of <code>failOnInProgress</code> to <code>true</code>. If you want to allow such contracts when tests are to be generated, just set the flag to <code>false</code>.</p>
</div>
</div>
</div>
</div>
</div>