Sync docs from master to gh-pages
This commit is contained in:
buildmaster
@@ -115,7 +115,7 @@ or build only tasks with names <code class="literal">spring-cloud-build,spring-c
|
||||
the <code class="literal">spring-cloud-cli.version</code> to <code class="literal">1.0.0.RELEASE</code> regardless of what was set in <code class="literal">spring-cloud-release</code> project. Example <code class="literal">--releaser.fixed-versions[spring-cloud-cli]=1.0.0.RELEASE</code>.
|
||||
Use these properties to provide versions for the meta release.</li><li class="listitem"><code class="literal">releaser.meta-release.enabled</code> - You have to turn it on to enable a meta release. Defaults to <code class="literal">false</code></li><li class="listitem"><code class="literal">releaser.meta-release.git-org-url</code> - The URL of the Git organization. We’ll append each project’s name to it.
|
||||
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></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.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.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><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
|
||||
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></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.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-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.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><li class="listitem"><code class="literal">releaser.git.update-spring-project</code> - If <code class="literal">true</code> then will update Spring Project page with the current release train values. 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
|
||||
|
||||
@@ -115,7 +115,7 @@ or build only tasks with names <code class="literal">spring-cloud-build,spring-c
|
||||
the <code class="literal">spring-cloud-cli.version</code> to <code class="literal">1.0.0.RELEASE</code> regardless of what was set in <code class="literal">spring-cloud-release</code> project. Example <code class="literal">--releaser.fixed-versions[spring-cloud-cli]=1.0.0.RELEASE</code>.
|
||||
Use these properties to provide versions for the meta release.</li><li class="listitem"><code class="literal">releaser.meta-release.enabled</code> - You have to turn it on to enable a meta release. Defaults to <code class="literal">false</code></li><li class="listitem"><code class="literal">releaser.meta-release.git-org-url</code> - The URL of the Git organization. We’ll append each project’s name to it.
|
||||
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></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.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.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><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
|
||||
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></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.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-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.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><li class="listitem"><code class="literal">releaser.git.update-spring-project</code> - If <code class="literal">true</code> then will update Spring Project page with the current release train values. 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
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<book xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
|
||||
<info>
|
||||
<title>Spring Cloud Release Tools</title>
|
||||
<date>2018-10-17</date>
|
||||
<date>2018-10-18</date>
|
||||
</info>
|
||||
<chapter xml:id="_spring_cloud_release_tools">
|
||||
<title>Spring Cloud Release Tools</title>
|
||||
@@ -326,12 +326,21 @@ train depends on projects that got already released. We default this list to <li
|
||||
<simpara><literal>releaser.git.documentation-branch</literal> - Branch to check out for the documentation project. Defaults to <literal>gh-pages</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.spring-project-url</literal> - URL to the documentation Git repository. Defaults to <literal><link xl:href="https://github.com/spring-projects/spring-cloud">https://github.com/spring-projects/spring-cloud</link></literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.spring-project-branch</literal> - Branch to check out for the documentation project. Defaults to <literal>gh-pages</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.update-documentation-repo</literal> - If <literal>true</literal> then will update documentation repository with the <literal>current</literal> URL. Defaults to <literal>true</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.update-spring-guides</literal> - If <literal>true</literal> then will update Spring Guides with the current release train. Defaults to <literal>true</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.update-spring-project</literal> - If <literal>true</literal> then will update Spring Project page with the current release train values. Defaults to <literal>true</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.oauth-token</literal> - GitHub OAuth token to be used to interact with GitHub repo.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
|
||||
Reference in New Issue
Block a user