159 lines
43 KiB
HTML
159 lines
43 KiB
HTML
<html><head>
|
|
<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.79.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="https://spring.io" target="_top">https://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
|
|
$ ./mvnw clean install</pre><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>You must set the value of the OAuth token. You can do it either via
|
|
the command line <code class="literal">--releaser.git.oauth-token=…​</code> or put it as an env variable in <code class="literal">.bashrc</code>
|
|
or <code class="literal">.zshrc</code> e.g. <code class="literal">export RELEASER_GIT_OAUTH_TOKEN=…​</code></p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_how_to_run_it_interactive_mode" href="#_how_to_run_it_interactive_mode"></a>1.3 How to run it (interactive mode)</h2></div></div></div><p>Go to your project (e.g. Spring Cloud Sleuth)</p><pre class="programlisting">$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">cd</span> spring-cloud-sleuth
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-comment"># example of running the releaser agains Dalston.SR1 tag with 1.0.0.BUILD-SNAPSHOT version of the releaser</span>
|
|
$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser</pre><p>The application will start running from your working directory. Running this code
|
|
follows the convention that you have the OAuth token environment variable set. It also assumes
|
|
that you might have some custom configuration in <code class="literal">config/releaser.yml</code> file. This setting is optional - if
|
|
you don’t have that file, nothing will happen.</p><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>It is important that you clone the repository you are going to release using SSH in order for the
|
|
<code class="literal">releaser</code> to be able to push tags and commit changes automatically.</p></td></tr></table></div><p>You will see text similar to this one</p><pre class="screen">=== WHAT DO YOU WANT TO DO? ===
|
|
|
|
0) Perform a full release of this project without interruptions
|
|
1) Perform a full release of this project in a verbose mode (you'll be asked about skipping steps)
|
|
2) Update poms with versions from Spring Cloud Release
|
|
3) Build the project
|
|
4) Commit, tag and push the tag
|
|
5) Deploy the artifacts
|
|
6) Publish the docs
|
|
7) Go back to snapshots and bump originalVersion by patch
|
|
8) Push the commits
|
|
9) Close the milestone at Github
|
|
10) Create email / blog / tweet etc. templates
|
|
|
|
You can pick a range of options by using the hyphen - e.g. '2-4' will execute jobs [2,3,4]
|
|
You can execute all tasks starting from a job by using a hyphen and providing only one number - e.g. '8-' will execute jobs [8,9,10]
|
|
You can execute given tasks by providing a comma separated list of tasks - e.g. '3,7,8' will execute jobs [3,7,8]
|
|
|
|
You can press 'q' to quit</pre><p>Just pick a number and continue! Pick either a full release or single steps. You can also pick
|
|
ranges or multiple steps. You can also provide the range only with the starting step
|
|
- that you will execute all steps starting from the given one.</p><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>Read before picking a number cause it might have changed between tool releases ;)</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_how_to_run_it_automatic_mode" href="#_how_to_run_it_automatic_mode"></a>1.4 How to run it (automatic mode)</h2></div></div></div><p>Go to your project (e.g. Spring Cloud Sleuth) and execute the application with <code class="literal">-h</code> or <code class="literal">--help</code>
|
|
flag.</p><pre class="programlisting">$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">cd</span> spring-cloud-sleuth
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-comment"># example of running the releaser agains Dalston.SR1 tag with 1.0.0.BUILD-SNAPSHOT version of the releaser</span>
|
|
$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -h</pre><p>You will see a help screen looking like more or less like this</p><pre class="programlisting">Here you can find the list of tasks in order
|
|
|
|
[release,releaseVerbose,metaRelease,postRelease,updatePoms,build,commit,deploy,docs,snapshots,push,closeMilestone,updateSagan,createTemplates,updateGuides,updateDocumentation]
|
|
|
|
|
|
Option Description
|
|
------ -----------
|
|
-a, --start-from <String> Starts all release task starting from the
|
|
given task. Requires passing the task
|
|
name (either one letter or the full
|
|
name)
|
|
-b, --build [String] Build the project
|
|
-c, --commit [String] Commit, tag and push the tag
|
|
-d, --deploy [String] Deploy the artifacts
|
|
-f, --full-release [Boolean] Do you want to <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">do</span> the full release of a
|
|
single project? (default: false)
|
|
-g, --updateSagan [String] Updating Sagan with release info
|
|
-h, --help [String]
|
|
-i, --interactive <Boolean> Do you want to <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">set</span> the properties from
|
|
the command line of a single project?
|
|
(default: true)
|
|
-m, --closeMilestone [String] Close the milestone at Github
|
|
-o, --docs [String] Publish the docs
|
|
-p, --push [String] Push the commits
|
|
-r, --range <String> Runs release tasks from the given range.
|
|
Requires passing the task names with a
|
|
hyphen. The first task is inclusive,
|
|
the second inclusive. E.g. <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'s-m'</span> would
|
|
mean running <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'snapshot'</span>, <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'push'</span> and
|
|
<span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'milestone'</span> tasks
|
|
-s, --snapshots [String] Go back to snapshots and bump
|
|
originalVersion by patch
|
|
-t, --createTemplates [String] Create email / blog / tweet etc. templates
|
|
--task-names, --tn <String> Starts all release task <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">for</span> the given
|
|
task names
|
|
-u, --updatePoms [String] Update poms with versions from Spring
|
|
Cloud Release
|
|
--ud, --updateDocumentation [String] Updating documentation repository
|
|
--ug, --updateGuides [String] Updating Spring Guides
|
|
-x, --meta-release <Boolean> Do you want to <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">do</span> the meta release?
|
|
(default: false)
|
|
|
|
Examples of usage:
|
|
|
|
Run <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'build'</span> & <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'commit'</span> & <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'deploy'</span>
|
|
java -jar jar.jar -b -c -d
|
|
|
|
Start from <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'push'</span>
|
|
java -jar releaser.jar -a push
|
|
|
|
Range <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'docs'</span> -> <span xmlns:d="http://docbook.org/ns/docbook" class="hl-string">'push'</span>
|
|
java -jar releaser.jar -r o-p</pre><p>The Releaser can use two sets of options. The configuration options like <code class="literal">releaser.pom.branch</code>
|
|
and the task switches. For the tasks you can use either the full names or short switches. For example
|
|
providing range of tasks via switches <code class="literal">o-p</code> is equivalent to full name <code class="literal">docs-push</code>.</p><p>A couple of examples:</p><p><b>Doing the full release in interactive mode (asking for skipping steps). </b>
|
|
</p><pre class="programlisting">$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">cd</span> spring-cloud-sleuth
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-comment"># example of running the releaser agains Dalston.SR1 tag with 1.0.0.BUILD-SNAPSHOT version of the releaser</span>
|
|
$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser --full-release</pre><p>
|
|
</p><p><b>Doing the full release in non interactive mode (automatic release). </b>
|
|
</p><pre class="programlisting">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser --full-release --interactive=false</pre><p>
|
|
</p><p><b>Updating pom, closing milestone & createTemplates in interactive mode. </b>
|
|
</p><pre class="programlisting">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -u -m -t</pre><p>
|
|
</p><p><b>Running all tasks starting from 'push' (automatic). </b>
|
|
</p><pre class="programlisting">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -a push -i=false</pre><p>
|
|
</p><p><b>Running tasks from 'docs' (inclusive) to 'push' (inclusive) (automatic). </b>
|
|
</p><pre class="programlisting">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -r d-p -i=false</pre><p>
|
|
</p><p><b>Running single task 'closeMilestone' (automatic). </b>
|
|
</p><pre class="programlisting">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser --closeMilestone -i=false</pre><p>
|
|
</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_how_to_run_meta_release_automatic_mode" href="#_how_to_run_meta_release_automatic_mode"></a>1.5 How to run meta-release (automatic-mode)</h2></div></div></div><p>All you have to do is run the jar with the releaser and pass the
|
|
<code class="literal">-x=true</code> option to turn on meta-release and a list of fixed versions
|
|
in the `--"releaser.fixed-versions[project-name]=project-version" format</p><pre class="screen">$ java -jar spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --spring.config.name=releaser -x=true --"releaser.fixed-versions[spring-cloud-sleuth]=2.0.1.BUILD-SNAPSHOT"</pre><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 release the <code class="literal">startFrom</code> or <code class="literal">taskNames</code> take into consideration
|
|
the project names, not task names. E.g. you can start from <code class="literal">spring-cloud-netflix</code> project,
|
|
or build only tasks with names <code class="literal">spring-cloud-build,spring-cloud-sleuth</code>.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_project_options" href="#_project_options"></a>1.6 Project options</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="literal">releaser.fixed-versions</code> - A String to String mapping of manually set versions. E.g. <code class="literal">"spring-cloud-cli" → "1.0.0.RELEASE"</code> will set
|
|
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><li class="listitem"><code class="literal">releaser.git.update-documentation-repo</code> - If <code class="literal">true</code> then will update documentation repository with the <code class="literal">current</code> URL. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.spring-project-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-projects/spring-cloud" target="_top">https://github.com/spring-projects/spring-cloud</a></code>.</li><li class="listitem"><code class="literal">releaser.git.spring-project-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-project</code> - If <code class="literal">true</code> then will update Project Sagan with the current release train values. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.test-samples-project-url</code> - URL to the test samples to be checked against the given release train. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-core-tests" target="_top">https://github.com/spring-cloud/spring-cloud-core-tests</a></code>.</li><li class="listitem"><code class="literal">releaser.git.test-samples-project-branch</code> - Branch to check out for test samples. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-wiki-url</code> - URL to the project’s release train wiki page. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-projects/spring-cloud.wiki.git" target="_top">https://github.com/spring-projects/spring-cloud.wiki.git</a></code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-wiki</code> - If <code class="literal">true</code> then will update the release train wiki page with the current release train values. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.run-updated-samples</code> - If <code class="literal">true</code> then will update samples and run the the build. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.all-test-samples-urls</code> - URLs to the test samples to be cloned and updated with proper snapshot versions.
|
|
E.g. <code class="literal">"--releaser.git.all-test-samples-urls[spring-cloud-sleuth]=https://github.com/spring-cloud-samples/sleuth-issues/,https://github.com/spring-cloud-samples/sleuth-documentation-apps/"</code>.
|
|
Defaults to Sleuth and Contract samples.</li><li class="listitem"><code class="literal">releaser.git.update-all-test-samples</code> - If <code class="literal">true</code> then will update samples with bumped snapshots after release. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-url</code> - URL to the release train documentation. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud-sample/scripts" target="_top">https://github.com/spring-cloud-sample/scripts</a></code>.</li><li class="listitem"><code class="literal">releaser.git.release-train-docs-branch</code> - Branch to check out for release train documentation. Defaults to <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.git.update-release-train-docs</code> - If <code class="literal">true</code> then will update the release train documentation project and run the generation. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.update-spring-guides</code> - If <code class="literal">true</code> then will update Spring Guides with the current release train. Defaults to <code class="literal">true</code>.</li></ul></div><p>The following properties are used for both meta release and a release of an individual module.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="literal">releaser.post-release-tasks-only</code> - If set to <code class="literal">true</code> will run only post release tasks. Defaults to <code class="literal">false</code>.</li><li class="listitem"><code class="literal">releaser.meta-release.release-train-project-name</code> - Name of the project that represents the BOM of the release train. Defaults to <code class="literal">spring-cloud-release</code>.</li><li class="listitem"><code class="literal">releaser.meta-release.release-train-dependency-names</code> - Names of the projects that should be updated with the version of the release train. Defaults to <code class="literal">[spring-cloud, spring-cloud-dependencies, spring-cloud-starter]</code>.</li><li class="listitem"><code class="literal">releaser.git.fetch-versions-from-git</code> - If <code class="literal">true</code> then should fill the map of versions from Git. If <code class="literal">false</code> then picks fixed versions.</li><li class="listitem"><code class="literal">releaser.git.clone-destination-dir</code> - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory.</li><li class="listitem"><code class="literal">releaser.git.release-train-bom-url</code> - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-release" target="_top">https://github.com/spring-cloud/spring-cloud-release</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-url</code> - URL to the documentation Git repository. Defaults to <code class="literal"><a class="link" href="https://github.com/spring-cloud/spring-cloud-static" target="_top">https://github.com/spring-cloud/spring-cloud-static</a></code>.</li><li class="listitem"><code class="literal">releaser.git.documentation-branch</code> - Branch to check out for the documentation project. Defaults to <code class="literal">gh-pages</code>.</li><li class="listitem"><code class="literal">releaser.sagan.update-sagan</code> - If <code class="literal">true</code> then will update project sagan with information about this project. Defaults to <code class="literal">true</code>.</li><li class="listitem"><code class="literal">releaser.git.oauth-token</code> - GitHub OAuth token to be used to interact with GitHub repo.</li><li class="listitem"><code class="literal">releaser.git.username</code> - Optional Git username. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.password</code> - Optional Git password. If not passed keys will be used for authentication.</li><li class="listitem"><code class="literal">releaser.git.number-of-checked-milestones</code> - In order not to iterate endlessly over milestones we introduce a threshold of milestones that
|
|
we will go through to find the matching milestone. Defaults to <code class="literal">10</code>.</li><li class="listitem"><code class="literal">releaser.maven.build-command</code> - Command to be executed to build the project. Defaults to <code class="literal">./mvnw clean install -Pdocs</code>.</li><li class="listitem"><code class="literal">releaser.maven.deploy-command</code> - Command to be executed to deploy a built project". Defaults to <code class="literal">./mvnw deploy -DskipTests -Pfast</code>.</li><li class="listitem"><code class="literal">releaser.maven.publish-docs-commands</code> - Command to be executed to deploy a built project. If present <code class="literal">{{version}}</code> will be replaced by the proper version.
|
|
Defaults to the standard Spring Cloud wget and execution of ghpages.</li><li class="listitem"><code class="literal">releaser.maven.system-properties</code> - Additional system properties that should be passed to any commands. If present <code class="literal">{{systemProps}}</code> will be replaced by the contents of this property.</li><li class="listitem"><code class="literal">releaser.maven.wait-time-in-minutes</code> - Max wait time in minutes for the process to finish. Defaults to <code class="literal">20</code>.</li><li class="listitem"><code class="literal">releaser.gradle.gradle-props-substitution</code> - a map containing a <code class="literal">key</code> which is a property key inside <code class="literal">gradle.properties</code> and a <code class="literal">value</code> of
|
|
a project name. E.g. in <code class="literal">gradle.properties</code> you have <code class="literal">foo=1.0.0.BUILD-SNAPSHOT</code> and you would like <code class="literal">spring-cloud-contract</code> version to
|
|
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 <code class="literal">master</code>.</li><li class="listitem"><code class="literal">releaser.pom.pom-with-boot-starter-parent</code> - What is the location of the <code class="literal">pom.xml</code> that contains the <code class="literal">spring-boot-starter-parent</code> as its parent pom. Defaults to <code class="literal">spring-cloud-starter-parent/pom.xml</code>.</li><li class="listitem"><code class="literal">releaser.pom.this-train-bom</code> - What is the location of the <code class="literal">pom.xml</code> that contains all the versions for the release train. Defaults to <code class="literal">spring-cloud-dependencies/pom.xml</code>.</li><li class="listitem"><code class="literal">releaser.pom.bom-version-pattern</code> - Regular expression that will match the versions of projects in the BOM pom.xml. Defaults to <code class="literal">^(spring-cloud-.*)\.version$</code>.</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><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>
|
|
then <span class="strong"><strong>remember to pass all arguments of the script there too</strong></span>. E.g. <code class="literal">./mvnw clean install ${@}</code>. That’s because
|
|
the releaser will pass any system properties to the <code class="literal">build</code> / <code class="literal">deploy</code> command, such as system properties
|
|
with keys and we need them to be passed inside the command executed by the releaser.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_examples" href="#_examples"></a>1.7 Examples</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_keeping_configuration_in_the_project" href="#_keeping_configuration_in_the_project"></a>1.7.1 Keeping configuration in the project</h3></div></div></div><p>If your project has some custom configuration (e.g. Spring Cloud Contract needs a script to be executed
|
|
to build the project and properly merge the docs) then you can put a file named e.g. <code class="literal">releaser.yml</code> under <code class="literal">config</code>
|
|
folder and run your application like this:</p><pre class="programlisting">$ wget https://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1.jar -O ../spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1.jar
|
|
$ java -jar target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1.jar --spring.config.name=releaser</pre><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>Notice that we’re downloading the jar to a parent folder, not to <code class="literal">target</code>. That’s because <code class="literal">target</code> get cleaned
|
|
during the build process</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 meta-releaser to work we assume that the path to the
|
|
configuration file is always <code class="literal">config/releaser.yml</code>.</p></td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_specifying_a_branch" href="#_specifying_a_branch"></a>1.7.2 Specifying A Branch</h3></div></div></div><p>By deafult the releaser will default to using the <code class="literal">master</code> branch of <code class="literal">spring-cloud-release</code>.
|
|
If you would like to use another branch you can specify it using the <code class="literal">releaser.pom.branch</code> property.</p><pre class="programlisting">$ java -jar spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1.jar --releaser.pom.branch=Camden.SR6</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_using_environment_variables" href="#_using_environment_variables"></a>1.7.3 Using Environment Variables</h3></div></div></div><p>In some cases it might be easier to specify environment variables instead of passing parameters to
|
|
<code class="literal">releaser</code>. For example, you might want to use environment variables if you are going to be
|
|
releasing multiple projects, this keeps you from having to specify the same parameters for
|
|
each release</p><pre class="programlisting">$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">export</span> RELEASER_POM_BRANCH=Dalston.RELEASE
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">export</span> RELEASER_GIT_OAUTH_TOKEN=...
|
|
$ wget https://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1.jar -O spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1.jar
|
|
$ java -jar target/spring-cloud-release-tools-spring-<span class="hl-number">1.0</span>.<span class="hl-number">0.</span>M1.jar --releaser.working-dir=/path/to/project/root</pre></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="_faq" href="#_faq"></a>1.8 FAQ</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="_jschexception_auth_fail" href="#_jschexception_auth_fail"></a>1.8.1 JSchException: Auth fail</h3></div></div></div><p>I got such an exception</p><pre class="screen">Caused by: org.eclipse.jgit.errors.TransportException: git@github.com:spring-cloud/spring-cloud-sleuth.git: Auth fail
|
|
at org.eclipse.jgit.transport.JschConfigSessionFactory.getSession(JschConfigSessionFactory.java:160) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
at org.eclipse.jgit.transport.SshTransport.getSession(SshTransport.java:137) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
at org.eclipse.jgit.transport.TransportGitSsh$SshPushConnection.<init>(TransportGitSsh.java:322) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
at org.eclipse.jgit.transport.TransportGitSsh.openPush(TransportGitSsh.java:167) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
at org.eclipse.jgit.transport.PushProcess.execute(PushProcess.java:160) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
at org.eclipse.jgit.transport.Transport.push(Transport.java:1275) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
at org.eclipse.jgit.api.PushCommand.call(PushCommand.java:161) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
... 25 common frames omitted
|
|
Caused by: com.jcraft.jsch.JSchException: Auth fail
|
|
at com.jcraft.jsch.Session.connect(Session.java:512) ~[jsch-0.1.53.jar!/:na]
|
|
at org.eclipse.jgit.transport.JschConfigSessionFactory.getSession(JschConfigSessionFactory.java:117) ~[org.eclipse.jgit-4.6.0.201612231935-r.jar!/:4.6.0.201612231935-r]
|
|
... 31 common frames omitted</pre><p>To fix that just call</p><pre class="programlisting"><span xmlns:d="http://docbook.org/ns/docbook" class="hl-comment"># to run the agent</span>
|
|
$ <span xmlns:d="http://docbook.org/ns/docbook" class="hl-keyword">eval</span> `ssh-agent`
|
|
<span xmlns:d="http://docbook.org/ns/docbook" class="hl-comment"># to store the pass in the agent</span>
|
|
$ ssh-add ~/.ssh/id_rsa</pre><p>before running the app</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="multi_spring-cloud-release-tools.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Spring Cloud Release Tools </td><td width="20%" align="center"><a accesskey="h" href="multi_spring-cloud-release-tools.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html> |