Sync docs from master to gh-pages

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

View File

@@ -580,6 +580,9 @@ contracts from temporary directories.</p>
<li>
<p><code>failOnNoContracts</code>: When enabled, will throw an exception when no contracts were found. Defaults to <code>true</code>.</p>
</li>
<li>
<p><code>failOnInProgress</code>: If set to true then if any contracts that are in progress are found, will break the build. On the producer side you need to be explicit about the fact that you have contracts in progress and take into consideration that you might be causing false positive test execution results on the consumer side.. Defaults to <code>true</code>.</p>
</li>
</ul>
</div>
<div class="paragraph">

View File

@@ -158,6 +158,7 @@ $(addBlockSwitches);
<li><a href="#how-to-use-stubs-from-a-location">15. How can I Use Stubs from a Location</a></li>
<li><a href="#how-to-generate-stubs-at-runtime">16. How can I Generate Stubs at Runtime</a></li>
<li><a href="#how-to-use-the-failonnostubs-feature">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">18. How can I Mark that a Contract Is in Progress</a></li>
</ul>
</div>
</div>
@@ -2498,6 +2499,17 @@ You need not specify the output directory for the generated snippets (since vers
</div>
</div>
</div>
<div class="sect1">
<h2 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">18. How can I Mark that a Contract Is in Progress</a></h2>
<div class="sectionbody">
<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="project-features.html#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>
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script>
<script type="text/javascript" src="js/toc.js"></script>

View File

@@ -515,6 +515,9 @@ components. Those properties might be used by (for example) built-in or custom S
<li>
<p><code>failOnNoContracts</code>: When enabled, will throw an exception when no contracts were found. Defaults to <code>true</code>.</p>
</li>
<li>
<p><code>failOnInProgress</code>: If set to true then if any contracts that are in progress are found, will break the build. On the producer side you need to be explicit about the fact that you have contracts in progress and take into consideration that you might be causing false positive test execution results on the consumer side.. Defaults to <code>true</code>.</p>
</li>
</ul>
</div>
<div class="paragraph">

View File

@@ -765,6 +765,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="sect3">
<h4 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">1.2.5. Passing Values from Files</a></h4>