Sync docs from master to gh-pages
This commit is contained in:
buildmaster
@@ -2,7 +2,7 @@
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>1. Spring Cloud Release Tools</title><link rel="stylesheet" type="text/css" href="css/manual-multipage.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="multi_spring-cloud-release-tools.html" title="Spring Cloud Release Tools"><link rel="up" href="multi_spring-cloud-release-tools.html" title="Spring Cloud Release Tools"><link rel="prev" href="multi_spring-cloud-release-tools.html" title="Spring Cloud Release Tools"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1. Spring Cloud Release Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="multi_spring-cloud-release-tools.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="_spring_cloud_release_tools" href="#_spring_cloud_release_tools"></a>1. Spring Cloud Release Tools</h1></div></div></div><p>Spring Cloud projects reuse the same pattern of building and deploying the applications. That’s
|
||||
why this tool makes it easy to automate the release / dependency update process of our applications.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_what_does_it_do" href="#_what_does_it_do"></a>1.1 What does it do?</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_single_project" href="#_single_project"></a>1.1.1 Single project</h3></div></div></div><p>For a single project</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects)</li><li class="listitem"><p class="simpara">Modifies the project versions with values from a BOM (e.g. for Spring Cloud it’s Spring Cloud Release)</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM</li></ul></div></li><li class="listitem"><p class="simpara">Performs the build and checks if the <code class="literal">docs</code> modules have properly created the documentation</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">throws an exception when in the <code class="literal">docs</code> module there’s an unresolved tag in any HTML file</li></ul></div></li><li class="listitem">Commits changed poms (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Creates a tag for the release / milestone (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Runs the deployment of the artifacts</li><li class="listitem">Publishes the docs (to <code class="literal">spring-cloud-static</code> for non-snapshots, to <code class="literal">gh-pages</code> for snapshots)</li><li class="listitem">Reverts back to snapshots, bumps the version by a patch (<code class="literal">1.0.1.RELEASE</code> → <code class="literal">1.0.2.BUILD-SNAPSHOT</code>) (ONLY FOR RELEASE VERSIONS)</li><li class="listitem">Closes the milestone on Github (e.g. <code class="literal">v1.0.1.RELEASE</code>) (ONLY FOR NON-SNAPSHOT VERSIONS)</li></ul></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>Starting with version that does Sagan integration, you MUST pass the OAuth token,
|
||||
otherwise the application will fail to start</p></td></tr></table></div><p>After project release</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Generates an email template under <code class="literal">target/email.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a blog template under <code class="literal">target/blog.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a tweet template under <code class="literal">target/tweet.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a release notes template under <code class="literal">target/notes.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Updates project information in Sagan (<a class="link" href="http://spring.io" target="_top">http://spring.io</a>) (ONLY FOR SNAPSHOT / RELEASE VERSIONS)</li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will create an issue in Spring Guides under <a class="link" href="https://github.com/spring-guides/getting-started-guides/issues/" target="_top">https://github.com/spring-guides/getting-started-guides/issues/</a></li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will update the links under <a class="link" href="https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current" target="_top">https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current</a></li><li class="listitem">Will update the release train project page (for Spring Cloud it will be <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></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_meta_release" href="#_meta_release"></a>1.1.2 Meta-release</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Uses the fixed versions to clone and check out each project (e.g. <code class="literal">spring-cloud-sleuth: 2.1.0.RELEASE</code>)</li><li class="listitem"><p class="simpara">From the version analyzes the branch and checks it out. E.g.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">for <code class="literal">spring-cloud-release’s `Finchley.RELEASE</code> version will resolve either <code class="literal">Finchley</code> branch or will fallback to <code class="literal">master</code> if there’s no <code class="literal">Finchley</code> branch.</li><li class="listitem">for <code class="literal">spring-cloud-sleuth’s `2.1.0.RELEASE</code> version will resolve <code class="literal">2.1.x</code> branch</li></ul></div></li><li class="listitem">Performs the release tasks per each project</li><li class="listitem">Performs the post release tasks at the end of the release</li><li class="listitem">Will update and run smoke test samples (for Spring Cloud it will be <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">Will clone provided test samples and will update all versions to the latest ones</li></ul></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 meta-releaser to work we assume that the path to the
|
||||
otherwise the application will fail to start</p></td></tr></table></div><p>After project release</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Generates an email template under <code class="literal">target/email.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a blog template under <code class="literal">target/blog.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a tweet template under <code class="literal">target/tweet.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a release notes template under <code class="literal">target/notes.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Updates project information in Sagan (<a class="link" href="http://spring.io" target="_top">http://spring.io</a>) (ONLY FOR SNAPSHOT / RELEASE VERSIONS)</li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will create an issue in Spring Guides under <a class="link" href="https://github.com/spring-guides/getting-started-guides/issues/" target="_top">https://github.com/spring-guides/getting-started-guides/issues/</a></li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will update the links under <a class="link" href="https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current" target="_top">https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current</a></li><li class="listitem">Will update the release train project page (for Spring Cloud it will be <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></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_meta_release" href="#_meta_release"></a>1.1.2 Meta-release</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Uses the fixed versions to clone and check out each project (e.g. <code class="literal">spring-cloud-sleuth: 2.1.0.RELEASE</code>)</li><li class="listitem"><p class="simpara">From the version analyzes the branch and checks it out. E.g.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">for <code class="literal">spring-cloud-release’s `Finchley.RELEASE</code> version will resolve either <code class="literal">Finchley</code> branch or will fallback to <code class="literal">master</code> if there’s no <code class="literal">Finchley</code> branch.</li><li class="listitem">for <code class="literal">spring-cloud-sleuth’s `2.1.0.RELEASE</code> version will resolve <code class="literal">2.1.x</code> branch</li></ul></div></li><li class="listitem">Performs the release tasks per each project</li><li class="listitem">Performs the post release tasks at the end of the release</li><li class="listitem">Will update and run smoke test samples (for Spring Cloud it will be <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">Will clone provided test samples and will update all versions to the latest ones</li><li class="listitem">Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be <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></ul></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 meta-releaser to work we assume that the path to the
|
||||
custom configuration file for each project is always <code class="literal">config/releaser.yml</code>.</p></td></tr></table></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_what_should_i_do_first" href="#_what_should_i_do_first"></a>1.2 What should I do first?</h2></div></div></div><p>Members of the Spring Cloud Team typically use this tool as follows. They first
|
||||
clone the releaser locally and build the jar manually</p><pre class="programlisting">$ git clone git@github.com:spring-cloud/spring-cloud-release-tools.git
|
||||
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">cd</span> spring-cloud-release-tools
|
||||
@@ -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.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 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.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.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.
|
||||
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.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.sagan.update-sagan</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’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 and run the the build. 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><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.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>Spring Cloud Release Tools</title><link rel="stylesheet" type="text/css" href="css/manual-singlepage.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="book"><div class="titlepage"><div><div><h1 class="title"><a name="d0e3"></a>Spring Cloud Release Tools</h1></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#_spring_cloud_release_tools">1. Spring Cloud Release Tools</a></span></dt><dd><dl><dt><span class="section"><a href="#_what_does_it_do">1.1. What does it do?</a></span></dt><dd><dl><dt><span class="section"><a href="#_single_project">1.1.1. Single project</a></span></dt><dt><span class="section"><a href="#_meta_release">1.1.2. Meta-release</a></span></dt></dl></dd><dt><span class="section"><a href="#_what_should_i_do_first">1.2. What should I do first?</a></span></dt><dt><span class="section"><a href="#_how_to_run_it_interactive_mode">1.3. How to run it (interactive mode)</a></span></dt><dt><span class="section"><a href="#_how_to_run_it_automatic_mode">1.4. How to run it (automatic mode)</a></span></dt><dt><span class="section"><a href="#_how_to_run_meta_release_automatic_mode">1.5. How to run meta-release (automatic-mode)</a></span></dt><dt><span class="section"><a href="#_project_options">1.6. Project options</a></span></dt><dt><span class="section"><a href="#_examples">1.7. Examples</a></span></dt><dd><dl><dt><span class="section"><a href="#_keeping_configuration_in_the_project">1.7.1. Keeping configuration in the project</a></span></dt><dt><span class="section"><a href="#_specifying_a_branch">1.7.2. Specifying A Branch</a></span></dt><dt><span class="section"><a href="#_using_environment_variables">1.7.3. Using Environment Variables</a></span></dt></dl></dd><dt><span class="section"><a href="#_faq">1.8. FAQ</a></span></dt><dd><dl><dt><span class="section"><a href="#_jschexception_auth_fail">1.8.1. JSchException: Auth fail</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="_spring_cloud_release_tools" href="#_spring_cloud_release_tools"></a>1. Spring Cloud Release Tools</h1></div></div></div><p>Spring Cloud projects reuse the same pattern of building and deploying the applications. That’s
|
||||
why this tool makes it easy to automate the release / dependency update process of our applications.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_what_does_it_do" href="#_what_does_it_do"></a>1.1 What does it do?</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_single_project" href="#_single_project"></a>1.1.1 Single project</h3></div></div></div><p>For a single project</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects)</li><li class="listitem"><p class="simpara">Modifies the project versions with values from a BOM (e.g. for Spring Cloud it’s Spring Cloud Release)</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM</li></ul></div></li><li class="listitem"><p class="simpara">Performs the build and checks if the <code class="literal">docs</code> modules have properly created the documentation</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">throws an exception when in the <code class="literal">docs</code> module there’s an unresolved tag in any HTML file</li></ul></div></li><li class="listitem">Commits changed poms (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Creates a tag for the release / milestone (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Runs the deployment of the artifacts</li><li class="listitem">Publishes the docs (to <code class="literal">spring-cloud-static</code> for non-snapshots, to <code class="literal">gh-pages</code> for snapshots)</li><li class="listitem">Reverts back to snapshots, bumps the version by a patch (<code class="literal">1.0.1.RELEASE</code> → <code class="literal">1.0.2.BUILD-SNAPSHOT</code>) (ONLY FOR RELEASE VERSIONS)</li><li class="listitem">Closes the milestone on Github (e.g. <code class="literal">v1.0.1.RELEASE</code>) (ONLY FOR NON-SNAPSHOT VERSIONS)</li></ul></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>Starting with version that does Sagan integration, you MUST pass the OAuth token,
|
||||
otherwise the application will fail to start</p></td></tr></table></div><p>After project release</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Generates an email template under <code class="literal">target/email.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a blog template under <code class="literal">target/blog.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a tweet template under <code class="literal">target/tweet.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a release notes template under <code class="literal">target/notes.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Updates project information in Sagan (<a class="link" href="http://spring.io" target="_top">http://spring.io</a>) (ONLY FOR SNAPSHOT / RELEASE VERSIONS)</li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will create an issue in Spring Guides under <a class="link" href="https://github.com/spring-guides/getting-started-guides/issues/" target="_top">https://github.com/spring-guides/getting-started-guides/issues/</a></li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will update the links under <a class="link" href="https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current" target="_top">https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current</a></li><li class="listitem">Will update the release train project page (for Spring Cloud it will be <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></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_meta_release" href="#_meta_release"></a>1.1.2 Meta-release</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Uses the fixed versions to clone and check out each project (e.g. <code class="literal">spring-cloud-sleuth: 2.1.0.RELEASE</code>)</li><li class="listitem"><p class="simpara">From the version analyzes the branch and checks it out. E.g.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">for <code class="literal">spring-cloud-release’s `Finchley.RELEASE</code> version will resolve either <code class="literal">Finchley</code> branch or will fallback to <code class="literal">master</code> if there’s no <code class="literal">Finchley</code> branch.</li><li class="listitem">for <code class="literal">spring-cloud-sleuth’s `2.1.0.RELEASE</code> version will resolve <code class="literal">2.1.x</code> branch</li></ul></div></li><li class="listitem">Performs the release tasks per each project</li><li class="listitem">Performs the post release tasks at the end of the release</li><li class="listitem">Will update and run smoke test samples (for Spring Cloud it will be <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">Will clone provided test samples and will update all versions to the latest ones</li></ul></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 meta-releaser to work we assume that the path to the
|
||||
otherwise the application will fail to start</p></td></tr></table></div><p>After project release</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Generates an email template under <code class="literal">target/email.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a blog template under <code class="literal">target/blog.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a tweet template under <code class="literal">target/tweet.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Generates a release notes template under <code class="literal">target/notes.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</li><li class="listitem">Updates project information in Sagan (<a class="link" href="http://spring.io" target="_top">http://spring.io</a>) (ONLY FOR SNAPSHOT / RELEASE VERSIONS)</li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will create an issue in Spring Guides under <a class="link" href="https://github.com/spring-guides/getting-started-guides/issues/" target="_top">https://github.com/spring-guides/getting-started-guides/issues/</a></li><li class="listitem">For <code class="literal">GA</code>/ <code class="literal">SR</code> release will update the links under <a class="link" href="https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current" target="_top">https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current</a></li><li class="listitem">Will update the release train project page (for Spring Cloud it will be <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></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_meta_release" href="#_meta_release"></a>1.1.2 Meta-release</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Uses the fixed versions to clone and check out each project (e.g. <code class="literal">spring-cloud-sleuth: 2.1.0.RELEASE</code>)</li><li class="listitem"><p class="simpara">From the version analyzes the branch and checks it out. E.g.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">for <code class="literal">spring-cloud-release’s `Finchley.RELEASE</code> version will resolve either <code class="literal">Finchley</code> branch or will fallback to <code class="literal">master</code> if there’s no <code class="literal">Finchley</code> branch.</li><li class="listitem">for <code class="literal">spring-cloud-sleuth’s `2.1.0.RELEASE</code> version will resolve <code class="literal">2.1.x</code> branch</li></ul></div></li><li class="listitem">Performs the release tasks per each project</li><li class="listitem">Performs the post release tasks at the end of the release</li><li class="listitem">Will update and run smoke test samples (for Spring Cloud it will be <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">Will clone provided test samples and will update all versions to the latest ones</li><li class="listitem">Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be <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></ul></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 meta-releaser to work we assume that the path to the
|
||||
custom configuration file for each project is always <code class="literal">config/releaser.yml</code>.</p></td></tr></table></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_what_should_i_do_first" href="#_what_should_i_do_first"></a>1.2 What should I do first?</h2></div></div></div><p>Members of the Spring Cloud Team typically use this tool as follows. They first
|
||||
clone the releaser locally and build the jar manually</p><pre class="programlisting">$ git clone git@github.com:spring-cloud/spring-cloud-release-tools.git
|
||||
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">cd</span> spring-cloud-release-tools
|
||||
@@ -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.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 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.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.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.
|
||||
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.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.sagan.update-sagan</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’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 and run the the build. 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><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.
|
||||
|
||||
@@ -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-29</date>
|
||||
<date>2018-10-30</date>
|
||||
</info>
|
||||
<chapter xml:id="_spring_cloud_release_tools">
|
||||
<title>Spring Cloud Release Tools</title>
|
||||
@@ -115,6 +115,9 @@ otherwise the application will fail to start</simpara>
|
||||
<listitem>
|
||||
<simpara>Will clone provided test samples and will update all versions to the latest ones</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be <literal><link xl:href="https://github.com/spring-projects/spring-cloud.wiki.git">https://github.com/spring-projects/spring-cloud.wiki.git</link></literal>)</simpara>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<important>
|
||||
<simpara>For the meta-releaser to work we assume that the path to the
|
||||
@@ -344,7 +347,10 @@ train depends on projects that got already released. We default this list to <li
|
||||
<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-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>
|
||||
<simpara><literal>releaser.sagan.update-sagan</literal> - Branch to check out for the documentation project. Defaults to <literal>gh-pages</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.update-spring-project</literal> - If <literal>true</literal> then will update Project Sagan with the current release train values. Defaults to <literal>true</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.test-samples-project-url</literal> - URL to the test samples to be checked against the given release train. Defaults to <literal><link xl:href="https://github.com/spring-cloud/spring-cloud-core-tests">https://github.com/spring-cloud/spring-cloud-core-tests</link></literal>.</simpara>
|
||||
@@ -353,6 +359,12 @@ train depends on projects that got already released. We default this list to <li
|
||||
<simpara><literal>releaser.git.test-samples-project-branch</literal> - Branch to check out for test samples. Defaults to <literal>master</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.release-train-wiki-url</literal> - URL to the project’s release train wiki page. Defaults to <literal><link xl:href="https://github.com/spring-projects/spring-cloud.wiki.git">https://github.com/spring-projects/spring-cloud.wiki.git</link></literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.update-release-train-wiki</literal> - If <literal>true</literal> then will update the release train wiki page with the current release train values. Defaults to <literal>true</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara><literal>releaser.git.run-updated-samples</literal> - If <literal>true</literal> then will update samples and run the the build. Defaults to <literal>true</literal>.</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
|
||||
Reference in New Issue
Block a user