From f9601d42b18238ab50aea4b36d51be6d5b796546 Mon Sep 17 00:00:00 2001
From: buildmaster <buildmaster@springframework.org>
Date: Wed, 31 Oct 2018 09:28:27 +0000
Subject: [PATCH] Sync docs from master to gh-pages

---
 multi/multi__spring_cloud_release_tools.html | 2 +-
 single/spring-cloud-release-tools.html       | 2 +-
 spring-cloud-release-tools.xml               | 3 +++
 3 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/multi/multi__spring_cloud_release_tools.html b/multi/multi__spring_cloud_release_tools.html
index c040ec3e..d1646746 100644
--- a/multi/multi__spring_cloud_release_tools.html
+++ b/multi/multi__spring_cloud_release_tools.html
@@ -117,7 +117,7 @@ Use these properties to provide versions for the meta release.</li><li class="li
 Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud" target="_top">https://github.com/spring-cloud</a></code></li><li class="listitem"><code class="literal">releaser.meta-release.projects-to-skip</code> - List of projects that we should not clone and release. Spring Cloud release
 train depends on projects that got already released. We default this list to <code class="literal">[spring-boot, spring-cloud-stream, spring-cloud-task]</code>.</li><li class="listitem"><code class="literal">releaser.git.update-documentation-repo</code> - If <code class="literal">true</code> then will update documentation repository with the <code class="literal">current</code> URL. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.spring-project-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-projects/spring-cloud" target="_top">https://github.com/spring-projects/spring-cloud</a></code>.</li><li class="listitem"><code class="literal">releaser.git.spring-project-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-project</code> - If <code class="literal">true</code> then will update Project Sagan with the current release train values. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.test-samples-project-url</code> - URL to the test samples to be checked against the given release train. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-core-tests" target="_top">https://github.com/spring-cloud/spring-cloud-core-tests</a></code>.</li><li class="listitem"><code class="literal">releaser.git.test-samples-project-branch</code> - Branch to check out for test samples. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-wiki-url</code> - URL to the project&#8217;s release train wiki page. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-projects/spring-cloud.wiki.git" target="_top">https://github.com/spring-projects/spring-cloud.wiki.git</a></code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-wiki</code> - If <code class="literal">true</code> then will update the release train wiki page with the current release train values. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.run-updated-samples</code> - If <code class="literal">true</code> then will update samples and run the the build. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.all-test-samples-urls</code> - URLs to the test samples to be cloned and updated with proper snapshot versions.
 E.g. <code class="literal">"--releaser.git.all-test-samples-urls[spring-cloud-sleuth]=https://github.com/spring-cloud-samples/sleuth-issues/,https://github.com/spring-cloud-samples/sleuth-documentation-apps/"</code>.
-Defaults to Sleuth and Contract samples.</li><li class="listitem"><code class="literal">releaser.git.update-all-test-samples</code> - If <code class="literal">true</code> then will update samples with bumped snapshots after release. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-url</code> - URL to the release train documentation. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud-sample/scripts" target="_top">https://github.com/spring-cloud-sample/scripts</a></code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-branch</code> - Branch to check out for release train documentation. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-docs</code> - If <code class="literal">true</code> then will update the release train documentation project and run the generation. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-guides</code> - If <code class="literal">true</code> then will update Spring Guides with the current release train. Defaults to <code class="literal">true</code>.</li></ul></div><p>The following properties are used for both meta release and a release of an individual module.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="literal">releaser.meta-release.release-train-project-name</code> - Name of the project that represents the BOM of the release train. Defaults to <code class="literal">spring-cloud-release</code>.</li><li class="listitem"><code class="literal">releaser.git.fetch-versions-from-git</code> - If <code class="literal">true</code> then should fill the map of versions from Git. If <code class="literal">false</code> then picks fixed versions.</li><li class="listitem"><code class="literal">releaser.git.clone-destination-dir</code> - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory.</li><li class="listitem"><code class="literal">releaser.git.release-train-bom-url</code> - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-release" target="_top">https://github.com/spring-cloud/spring-cloud-release</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-static" target="_top">https://github.com/spring-cloud/spring-cloud-static</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.sagan.update-sagan</code> - If <code class="literal">true</code> then will update project sagan with information about this project. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.oauth-token</code> - GitHub OAuth token to be used to interact with GitHub repo.</li><li class="listitem"><code class="literal">releaser.git.username</code> - Optional Git username. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.password</code> - Optional Git password. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.number-of-checked-milestones</code> - In order not to iterate endlessly over milestones we introduce a threshold of milestones that
+Defaults to Sleuth and Contract samples.</li><li class="listitem"><code class="literal">releaser.git.update-all-test-samples</code> - If <code class="literal">true</code> then will update samples with bumped snapshots after release. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-url</code> - URL to the release train documentation. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud-sample/scripts" target="_top">https://github.com/spring-cloud-sample/scripts</a></code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-branch</code> - Branch to check out for release train documentation. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-docs</code> - If <code class="literal">true</code> then will update the release train documentation project and run the generation. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-guides</code> - If <code class="literal">true</code> then will update Spring Guides with the current release train. Defaults to <code class="literal">true</code>.</li></ul></div><p>The following properties are used for both meta release and a release of an individual module.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="literal">releaser.post-release-tasks-only</code> - If set to <code class="literal">true</code> will run only post release tasks. Defaults to <code class="literal">false</code>.</li><li class="listitem"><code class="literal">releaser.meta-release.release-train-project-name</code> - Name of the project that represents the BOM of the release train. Defaults to <code class="literal">spring-cloud-release</code>.</li><li class="listitem"><code class="literal">releaser.git.fetch-versions-from-git</code> - If <code class="literal">true</code> then should fill the map of versions from Git. If <code class="literal">false</code> then picks fixed versions.</li><li class="listitem"><code class="literal">releaser.git.clone-destination-dir</code> - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory.</li><li class="listitem"><code class="literal">releaser.git.release-train-bom-url</code> - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-release" target="_top">https://github.com/spring-cloud/spring-cloud-release</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-static" target="_top">https://github.com/spring-cloud/spring-cloud-static</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.sagan.update-sagan</code> - If <code class="literal">true</code> then will update project sagan with information about this project. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.oauth-token</code> - GitHub OAuth token to be used to interact with GitHub repo.</li><li class="listitem"><code class="literal">releaser.git.username</code> - Optional Git username. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.password</code> - Optional Git password. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.number-of-checked-milestones</code> - In order not to iterate endlessly over milestones we introduce a threshold of milestones that
 we will go through to find the matching milestone. Defaults to <code class="literal">10</code>.</li><li class="listitem"><code class="literal">releaser.maven.build-command</code> - Command to be executed to build the project. Defaults to <code class="literal">./mvnw clean install -Pdocs</code>.</li><li class="listitem"><code class="literal">releaser.maven.deploy-command</code> - Command to be executed to deploy a built project". Defaults to <code class="literal">./mvnw deploy -DskipTests -Pfast</code>.</li><li class="listitem"><code class="literal">releaser.maven.publish-docs-commands</code> - Command to be executed to deploy a built project. If present <code class="literal">{{version}}</code> will be replaced by the proper version.
 Defaults to the standard Spring Cloud wget and execution of ghpages.</li><li class="listitem"><code class="literal">releaser.maven.system-properties</code> - Additional system properties that should be passed to any commands. If present <code class="literal">{{systemProps}}</code> will be replaced by the contents of this property.</li><li class="listitem"><code class="literal">releaser.maven.wait-time-in-minutes</code> - Max wait time in minutes for the process to finish. Defaults to <code class="literal">20</code>.</li><li class="listitem"><code class="literal">releaser.gradle.gradle-props-substitution</code> - a map containing a <code class="literal">key</code> which is a property key inside <code class="literal">gradle.properties</code> and a <code class="literal">value</code> of
 a project name. E.g. in <code class="literal">gradle.properties</code> you have <code class="literal">foo=1.0.0.BUILD-SNAPSHOT</code> and you would like <code class="literal">spring-cloud-contract</code> version to
diff --git a/single/spring-cloud-release-tools.html b/single/spring-cloud-release-tools.html
index ed62a91a..708de559 100644
--- a/single/spring-cloud-release-tools.html
+++ b/single/spring-cloud-release-tools.html
@@ -117,7 +117,7 @@ Use these properties to provide versions for the meta release.</li><li class="li
 Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud" target="_top">https://github.com/spring-cloud</a></code></li><li class="listitem"><code class="literal">releaser.meta-release.projects-to-skip</code> - List of projects that we should not clone and release. Spring Cloud release
 train depends on projects that got already released. We default this list to <code class="literal">[spring-boot, spring-cloud-stream, spring-cloud-task]</code>.</li><li class="listitem"><code class="literal">releaser.git.update-documentation-repo</code> - If <code class="literal">true</code> then will update documentation repository with the <code class="literal">current</code> URL. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.spring-project-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-projects/spring-cloud" target="_top">https://github.com/spring-projects/spring-cloud</a></code>.</li><li class="listitem"><code class="literal">releaser.git.spring-project-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-project</code> - If <code class="literal">true</code> then will update Project Sagan with the current release train values. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.test-samples-project-url</code> - URL to the test samples to be checked against the given release train. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-core-tests" target="_top">https://github.com/spring-cloud/spring-cloud-core-tests</a></code>.</li><li class="listitem"><code class="literal">releaser.git.test-samples-project-branch</code> - Branch to check out for test samples. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-wiki-url</code> - URL to the project&#8217;s release train wiki page. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-projects/spring-cloud.wiki.git" target="_top">https://github.com/spring-projects/spring-cloud.wiki.git</a></code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-wiki</code> - If <code class="literal">true</code> then will update the release train wiki page with the current release train values. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.run-updated-samples</code> - If <code class="literal">true</code> then will update samples and run the the build. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.all-test-samples-urls</code> - URLs to the test samples to be cloned and updated with proper snapshot versions.
 E.g. <code class="literal">"--releaser.git.all-test-samples-urls[spring-cloud-sleuth]=https://github.com/spring-cloud-samples/sleuth-issues/,https://github.com/spring-cloud-samples/sleuth-documentation-apps/"</code>.
-Defaults to Sleuth and Contract samples.</li><li class="listitem"><code class="literal">releaser.git.update-all-test-samples</code> - If <code class="literal">true</code> then will update samples with bumped snapshots after release. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-url</code> - URL to the release train documentation. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud-sample/scripts" target="_top">https://github.com/spring-cloud-sample/scripts</a></code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-branch</code> - Branch to check out for release train documentation. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-docs</code> - If <code class="literal">true</code> then will update the release train documentation project and run the generation. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-guides</code> - If <code class="literal">true</code> then will update Spring Guides with the current release train. Defaults to <code class="literal">true</code>.</li></ul></div><p>The following properties are used for both meta release and a release of an individual module.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="literal">releaser.meta-release.release-train-project-name</code> - Name of the project that represents the BOM of the release train. Defaults to <code class="literal">spring-cloud-release</code>.</li><li class="listitem"><code class="literal">releaser.git.fetch-versions-from-git</code> - If <code class="literal">true</code> then should fill the map of versions from Git. If <code class="literal">false</code> then picks fixed versions.</li><li class="listitem"><code class="literal">releaser.git.clone-destination-dir</code> - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory.</li><li class="listitem"><code class="literal">releaser.git.release-train-bom-url</code> - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-release" target="_top">https://github.com/spring-cloud/spring-cloud-release</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-static" target="_top">https://github.com/spring-cloud/spring-cloud-static</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.sagan.update-sagan</code> - If <code class="literal">true</code> then will update project sagan with information about this project. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.oauth-token</code> - GitHub OAuth token to be used to interact with GitHub repo.</li><li class="listitem"><code class="literal">releaser.git.username</code> - Optional Git username. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.password</code> - Optional Git password. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.number-of-checked-milestones</code> - In order not to iterate endlessly over milestones we introduce a threshold of milestones that
+Defaults to Sleuth and Contract samples.</li><li class="listitem"><code class="literal">releaser.git.update-all-test-samples</code> - If <code class="literal">true</code> then will update samples with bumped snapshots after release. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-url</code> - URL to the release train documentation. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud-sample/scripts" target="_top">https://github.com/spring-cloud-sample/scripts</a></code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-branch</code> - Branch to check out for release train documentation. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-docs</code> - If <code class="literal">true</code> then will update the release train documentation project and run the generation. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-guides</code> - If <code class="literal">true</code> then will update Spring Guides with the current release train. Defaults to <code class="literal">true</code>.</li></ul></div><p>The following properties are used for both meta release and a release of an individual module.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="literal">releaser.post-release-tasks-only</code> - If set to <code class="literal">true</code> will run only post release tasks. Defaults to <code class="literal">false</code>.</li><li class="listitem"><code class="literal">releaser.meta-release.release-train-project-name</code> - Name of the project that represents the BOM of the release train. Defaults to <code class="literal">spring-cloud-release</code>.</li><li class="listitem"><code class="literal">releaser.git.fetch-versions-from-git</code> - If <code class="literal">true</code> then should fill the map of versions from Git. If <code class="literal">false</code> then picks fixed versions.</li><li class="listitem"><code class="literal">releaser.git.clone-destination-dir</code> - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory.</li><li class="listitem"><code class="literal">releaser.git.release-train-bom-url</code> - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-release" target="_top">https://github.com/spring-cloud/spring-cloud-release</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-static" target="_top">https://github.com/spring-cloud/spring-cloud-static</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.sagan.update-sagan</code> - If <code class="literal">true</code> then will update project sagan with information about this project. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.oauth-token</code> - GitHub OAuth token to be used to interact with GitHub repo.</li><li class="listitem"><code class="literal">releaser.git.username</code> - Optional Git username. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.password</code> - Optional Git password. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.number-of-checked-milestones</code> - In order not to iterate endlessly over milestones we introduce a threshold of milestones that
 we will go through to find the matching milestone. Defaults to <code class="literal">10</code>.</li><li class="listitem"><code class="literal">releaser.maven.build-command</code> - Command to be executed to build the project. Defaults to <code class="literal">./mvnw clean install -Pdocs</code>.</li><li class="listitem"><code class="literal">releaser.maven.deploy-command</code> - Command to be executed to deploy a built project". Defaults to <code class="literal">./mvnw deploy -DskipTests -Pfast</code>.</li><li class="listitem"><code class="literal">releaser.maven.publish-docs-commands</code> - Command to be executed to deploy a built project. If present <code class="literal">{{version}}</code> will be replaced by the proper version.
 Defaults to the standard Spring Cloud wget and execution of ghpages.</li><li class="listitem"><code class="literal">releaser.maven.system-properties</code> - Additional system properties that should be passed to any commands. If present <code class="literal">{{systemProps}}</code> will be replaced by the contents of this property.</li><li class="listitem"><code class="literal">releaser.maven.wait-time-in-minutes</code> - Max wait time in minutes for the process to finish. Defaults to <code class="literal">20</code>.</li><li class="listitem"><code class="literal">releaser.gradle.gradle-props-substitution</code> - a map containing a <code class="literal">key</code> which is a property key inside <code class="literal">gradle.properties</code> and a <code class="literal">value</code> of
 a project name. E.g. in <code class="literal">gradle.properties</code> you have <code class="literal">foo=1.0.0.BUILD-SNAPSHOT</code> and you would like <code class="literal">spring-cloud-contract</code> version to
diff --git a/spring-cloud-release-tools.xml b/spring-cloud-release-tools.xml
index 8da33618..3bf24e11 100644
--- a/spring-cloud-release-tools.xml
+++ b/spring-cloud-release-tools.xml
@@ -367,6 +367,9 @@ Defaults to Sleuth and Contract samples.</simpara>
 <simpara>The following properties are used for both meta release and a release of an individual module.</simpara>
 <itemizedlist>
 <listitem>
+<simpara><literal>releaser.post-release-tasks-only</literal> - If set to <literal>true</literal> will run only post release tasks. Defaults to <literal>false</literal>.</simpara>
+</listitem>
+<listitem>
 <simpara><literal>releaser.meta-release.release-train-project-name</literal> - Name of the project that represents the BOM of the release train. Defaults to <literal>spring-cloud-release</literal>.</simpara>
 </listitem>
 <listitem>