Sync docs from master to gh-pages
This commit is contained in:
buildmaster
@@ -115,13 +115,13 @@ 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.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.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><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.spring-cloud-release-git-url</code> - URL to Spring Cloud Release Git repository. Defaults to <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.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><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.spring-cloud-release-git-url</code> - URL to Spring Cloud Release Git repository. Defaults to <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
|
||||
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
|
||||
be set there. Just provide a mapping for the <code class="literal">gradle-props-substition</code> looking like this <code class="literal">foo=spring-cloud-contract</code> and the result
|
||||
(e.g for sc-contract version <code class="literal">2.0.0.RELEASE</code>) will be an updated <code class="literal">gradle.properties</code> with entry <code class="literal">foo=2.0.0.RELEASE</code></li><li class="listitem"><code class="literal">releaser.pom.branch</code> - Which branch of Spring Cloud Release should be checked out. Defaults to "master",</li><li class="listitem"><code class="literal">releaser.pom.ignored-pom-regex</code> - List of regular expressions of ignored poms. Defaults to test projects and samples.
|
||||
Example: <code class="literal">"--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"</code></li><li class="listitem"><code class="literal">releaser.working-dir</code> - By default Releaser assumes running the program from the current working directory.</li></ul></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/tip.png"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>You can pass the options either via system properties or via application arguments.
|
||||
Example: <code class="literal">"--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"</code></li><li class="listitem"><code class="literal">releaser.working-dir</code> - By default Releaser assumes running the program from the current working directory.</li><li class="listitem"><code class="literal">releaser.template.template-folder</code> - Tells which subfolder with templates to pick for blog, email etc. generation. Defaults to <code class="literal">cloud</code></li></ul></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/tip.png"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>You can pass the options either via system properties or via application arguments.
|
||||
Example for system properties: <code class="literal">java -Dreleaser.pom.branch=Camden.SR6 -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar</code>
|
||||
Example for application arguments: <code class="literal">java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6</code></p></td></tr></table></div><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/important.png"></td><th align="left">Important</th></tr><tr><td align="left" valign="top"><p>For the GA release to be successful, it’s important that if the <code class="literal">build</code> / <code class="literal">deploy</code> command
|
||||
run a script (e.g. <code class="literal">scripts/foo.sh</code>) then inside <code class="literal">foo.sh</code> if you call a Maven build <code class="literal">./mvnw clean install</code>
|
||||
|
||||
@@ -115,13 +115,13 @@ 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.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.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><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.spring-cloud-release-git-url</code> - URL to Spring Cloud Release Git repository. Defaults to <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.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><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.spring-cloud-release-git-url</code> - URL to Spring Cloud Release Git repository. Defaults to <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
|
||||
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
|
||||
be set there. Just provide a mapping for the <code class="literal">gradle-props-substition</code> looking like this <code class="literal">foo=spring-cloud-contract</code> and the result
|
||||
(e.g for sc-contract version <code class="literal">2.0.0.RELEASE</code>) will be an updated <code class="literal">gradle.properties</code> with entry <code class="literal">foo=2.0.0.RELEASE</code></li><li class="listitem"><code class="literal">releaser.pom.branch</code> - Which branch of Spring Cloud Release should be checked out. Defaults to "master",</li><li class="listitem"><code class="literal">releaser.pom.ignored-pom-regex</code> - List of regular expressions of ignored poms. Defaults to test projects and samples.
|
||||
Example: <code class="literal">"--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"</code></li><li class="listitem"><code class="literal">releaser.working-dir</code> - By default Releaser assumes running the program from the current working directory.</li></ul></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/tip.png"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>You can pass the options either via system properties or via application arguments.
|
||||
Example: <code class="literal">"--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"</code></li><li class="listitem"><code class="literal">releaser.working-dir</code> - By default Releaser assumes running the program from the current working directory.</li><li class="listitem"><code class="literal">releaser.template.template-folder</code> - Tells which subfolder with templates to pick for blog, email etc. generation. Defaults to <code class="literal">cloud</code></li></ul></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/tip.png"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>You can pass the options either via system properties or via application arguments.
|
||||
Example for system properties: <code class="literal">java -Dreleaser.pom.branch=Camden.SR6 -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar</code>
|
||||
Example for application arguments: <code class="literal">java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6</code></p></td></tr></table></div><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/important.png"></td><th align="left">Important</th></tr><tr><td align="left" valign="top"><p>For the GA release to be successful, it’s important that if the <code class="literal">build</code> / <code class="literal">deploy</code> command
|
||||
run a script (e.g. <code class="literal">scripts/foo.sh</code>) then inside <code class="literal">foo.sh</code> if you call a Maven build <code class="literal">./mvnw clean install</code>
|
||||
|
||||
@@ -323,6 +323,12 @@ 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.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.oauth-token</literal> - GitHub OAuth token to be used to interact with GitHub repo.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@@ -367,6 +373,9 @@ Example: <literal>"--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spr
|
||||
<listitem>
|
||||
<simpara><literal>releaser.working-dir</literal> - By default Releaser assumes running the program from the current working directory.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.template.template-folder</literal> - Tells which subfolder with templates to pick for blog, email etc. generation. Defaults to <literal>cloud</literal></simpara>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<tip>
|
||||
<simpara>You can pass the options either via system properties or via application arguments.
|
||||
|
||||
Reference in New Issue
Block a user