Sync docs from master to gh-pages
This commit is contained in:
buildmaster
@@ -5,8 +5,9 @@
|
||||
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="generator" content="Asciidoctor 1.5.7.1">
|
||||
<title>spring-cloud-release-tools</title>
|
||||
<link rel="stylesheet" href="css/manual-singlepage.css">
|
||||
<title>Spring Cloud Release Tools</title>
|
||||
<link rel="stylesheet" href="css/spring.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
|
||||
<style>
|
||||
.hidden {
|
||||
display: none;
|
||||
@@ -32,7 +33,7 @@
|
||||
color: #ffffff;
|
||||
}
|
||||
</style>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js"></script>
|
||||
<script src="http://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js"></script>
|
||||
<script type="text/javascript">
|
||||
function addBlockSwitches() {
|
||||
$('.primary').each(function() {
|
||||
@@ -82,36 +83,769 @@ $(addBlockSwitches);
|
||||
</script>
|
||||
</head>
|
||||
|
||||
<body class="article">
|
||||
<body class="book toc2 toc-left">
|
||||
<div id="header">
|
||||
<h1>spring-cloud-release-tools</h1>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div id="preamble">
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<p>1.0.0.BUILD-SNAPSHOT</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_pick_the_documentation_option">Pick The Documentation Option</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p><a href="single/spring-cloud-release-tools.html">Single HTML</a></p>
|
||||
<div id="toc" class="toc2">
|
||||
<div id="toctitle">Table of Contents</div>
|
||||
<ul class="sectlevel1">
|
||||
<li><a href="#_spring_cloud_release_tools">Spring Cloud Release Tools</a>
|
||||
<ul class="sectlevel2">
|
||||
<li><a href="#_what_does_it_do">What does it do?</a>
|
||||
<ul class="sectlevel3">
|
||||
<li><a href="#_single_project">Single project</a></li>
|
||||
<li><a href="#_meta_release">Meta-release</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="multi/multi_spring-cloud-release-tools.html">Multi HTML</a></p>
|
||||
<li><a href="#_what_should_i_do_first">What should I do first?</a></li>
|
||||
<li><a href="#_how_to_run_it_interactive_mode">How to run it (interactive mode)</a></li>
|
||||
<li><a href="#_how_to_run_it_automatic_mode">How to run it (automatic mode)</a></li>
|
||||
<li><a href="#_how_to_run_meta_release_automatic_mode">How to run meta-release (automatic-mode)</a></li>
|
||||
<li><a href="#_project_options">Project options</a></li>
|
||||
<li><a href="#_examples">Examples</a>
|
||||
<ul class="sectlevel3">
|
||||
<li><a href="#_keeping_configuration_in_the_project">Keeping configuration in the project</a></li>
|
||||
<li><a href="#_specifying_a_branch">Specifying A Branch</a></li>
|
||||
<li><a href="#_using_environment_variables">Using Environment Variables</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#_faq">FAQ</a>
|
||||
<ul class="sectlevel3">
|
||||
<li><a href="#_jschexception_auth_fail">JSchException: Auth fail</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div class="sect1">
|
||||
<h2 id="_spring_cloud_release_tools"><a class="link" href="#_spring_cloud_release_tools">Spring Cloud Release Tools</a></h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<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>
|
||||
<div class="sect2">
|
||||
<h3 id="_what_does_it_do"><a class="link" href="#_what_does_it_do">What does it do?</a></h3>
|
||||
<div class="sect3">
|
||||
<h4 id="_single_project"><a class="link" href="#_single_project">Single project</a></h4>
|
||||
<div class="paragraph">
|
||||
<p>For a single project</p>
|
||||
</div>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Modifies the project versions with values from a BOM (e.g. for Spring Cloud it’s Spring Cloud Release)</p>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Performs the build and checks if the <code>docs</code> modules have properly created the documentation</p>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>throws an exception when in the <code>docs</code> module there’s an unresolved tag in any HTML file</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Commits changed poms (ONLY FOR NON-SNAPSHOT VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Creates a tag for the release / milestone (ONLY FOR NON-SNAPSHOT VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Runs the deployment of the artifacts</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Publishes the docs (to <code>spring-cloud-static</code> for non-snapshots, to <code>gh-pages</code> for snapshots)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Reverts back to snapshots, bumps the version by a patch (<code>1.0.1.RELEASE</code> → <code>1.0.2.BUILD-SNAPSHOT</code>) (ONLY FOR RELEASE VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Closes the milestone on Github (e.g. <code>v1.0.1.RELEASE</code>) (ONLY FOR NON-SNAPSHOT VERSIONS)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="admonitionblock important">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-important" title="Important"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
Starting with version that does Sagan integration, you MUST pass the OAuth token,
|
||||
otherwise the application will fail to start
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>After project release</p>
|
||||
</div>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>Generates an email template under <code>target/email.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Generates a blog template under <code>target/blog.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Generates a tweet template under <code>target/tweet.txt</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Generates a release notes template under <code>target/notes.md</code> (ONLY FOR NON-SNAPSHOT VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Updates project information in Sagan (<a href="https://spring.io" class="bare">https://spring.io</a>) (ONLY FOR SNAPSHOT / RELEASE VERSIONS)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>For <code>GA</code>/ <code>SR</code> release will create an issue in Spring Guides under <a href="https://github.com/spring-guides/getting-started-guides/issues/" class="bare">https://github.com/spring-guides/getting-started-guides/issues/</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>For <code>GA</code>/ <code>SR</code> release will update the links under <a href="https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current" class="bare">https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Will update the release train project page (for Spring Cloud it will be <code><a href="https://github.com/spring-projects/spring-cloud" class="bare">https://github.com/spring-projects/spring-cloud</a></code>)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css">
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.js"></script>
|
||||
<script>prettyPrint()</script>
|
||||
<div class="sect3">
|
||||
<h4 id="_meta_release"><a class="link" href="#_meta_release">Meta-release</a></h4>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>Uses the fixed versions to clone and check out each project (e.g. <code>spring-cloud-sleuth: 2.1.0.RELEASE</code>)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>From the version analyzes the branch and checks it out. E.g.</p>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>for <code>spring-cloud-release’s `Finchley.RELEASE</code> version will resolve either <code>Finchley</code> branch or will fallback to <code>master</code> if there’s no <code>Finchley</code> branch.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>for <code>spring-cloud-sleuth’s `2.1.0.RELEASE</code> version will resolve <code>2.1.x</code> branch</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Performs the release tasks per each project</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Performs the post release tasks at the end of the release</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Will update and run smoke test samples (for Spring Cloud it will be <code><a href="https://github.com/spring-cloud/spring-cloud-core-tests" class="bare">https://github.com/spring-cloud/spring-cloud-core-tests</a></code>)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Will clone provided test samples and will update all versions to the latest ones</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be <code><a href="https://github.com/spring-projects/spring-cloud.wiki.git" class="bare">https://github.com/spring-projects/spring-cloud.wiki.git</a></code>)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="admonitionblock important">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-important" title="Important"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
For the meta-releaser to work we assume that the path to the
|
||||
custom configuration file for each project is always <code>config/releaser.yml</code>.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_what_should_i_do_first"><a class="link" href="#_what_should_i_do_first">What should I do first?</a></h3>
|
||||
<div class="paragraph">
|
||||
<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>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ git clone git@github.com:spring-cloud/spring-cloud-release-tools.git
|
||||
$ cd spring-cloud-release-tools
|
||||
$ ./mvnw clean install</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="admonitionblock important">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-important" title="Important"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
You must set the value of the OAuth token. You can do it either via
|
||||
the command line <code>--releaser.git.oauth-token=…​</code> or put it as an env variable in <code>.bashrc</code>
|
||||
or <code>.zshrc</code> e.g. <code>export RELEASER_GIT_OAUTH_TOKEN=…​</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_how_to_run_it_interactive_mode"><a class="link" href="#_how_to_run_it_interactive_mode">How to run it (interactive mode)</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>Go to your project (e.g. Spring Cloud Sleuth)</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
|
||||
$ cd spring-cloud-sleuth
|
||||
$ # example of running the releaser agains Dalston.SR1 tag with 1.0.0.BUILD-SNAPSHOT version of the releaser
|
||||
$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<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>config/releaser.yml</code> file. This setting is optional - if
|
||||
you don’t have that file, nothing will happen.</p>
|
||||
</div>
|
||||
<div class="admonitionblock tip">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-tip" title="Tip"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
It is important that you clone the repository you are going to release using SSH in order for the
|
||||
<code>releaser</code> to be able to push tags and commit changes automatically.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>You will see text similar to this one</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code>=== 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</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<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>
|
||||
<div class="admonitionblock tip">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-tip" title="Tip"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
Read before picking a number cause it might have changed between tool releases ;)
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_how_to_run_it_automatic_mode"><a class="link" href="#_how_to_run_it_automatic_mode">How to run it (automatic mode)</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>Go to your project (e.g. Spring Cloud Sleuth) and execute the application with <code>-h</code> or <code>--help</code>
|
||||
flag.</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
|
||||
$ cd spring-cloud-sleuth
|
||||
$ # example of running the releaser agains Dalston.SR1 tag with 1.0.0.BUILD-SNAPSHOT version of the releaser
|
||||
$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -h</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>You will see a help screen looking like more or less like this</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">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 do 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 set 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. 's-m' would
|
||||
mean running 'snapshot', 'push' and
|
||||
'milestone' 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 for 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 do the meta release?
|
||||
(default: false)
|
||||
|
||||
Examples of usage:
|
||||
|
||||
Run 'build' & 'commit' & 'deploy'
|
||||
java -jar jar.jar -b -c -d
|
||||
|
||||
Start from 'push'
|
||||
java -jar releaser.jar -a push
|
||||
|
||||
Range 'docs' -> 'push'
|
||||
java -jar releaser.jar -r o-p</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>The Releaser can use two sets of options. The configuration options like <code>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>o-p</code> is equivalent to full name <code>docs-push</code>.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>A couple of examples:</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="title">Doing the full release in interactive mode (asking for skipping steps)</div>
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
|
||||
$ cd spring-cloud-sleuth
|
||||
$ # example of running the releaser agains Dalston.SR1 tag with 1.0.0.BUILD-SNAPSHOT version of the releaser
|
||||
$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser --full-release</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="title">Doing the full release in non interactive mode (automatic release)</div>
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser --full-release --interactive=false</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="title">Updating pom, closing milestone & createTemplates in interactive mode</div>
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -u -m -t</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="title">Running all tasks starting from 'push' (automatic)</div>
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -a push -i=false</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="title">Running tasks from 'docs' (inclusive) to 'push' (inclusive) (automatic)</div>
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser -r d-p -i=false</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="title">Running single task 'closeMilestone' (automatic)</div>
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/target/spring-cloud-release-tools-spring-1.0.0.BUILD-SNAPSHOT.jar --releaser.pom.branch=vDalston.SR1 --spring.config.name=releaser --closeMilestone -i=false</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_how_to_run_meta_release_automatic_mode"><a class="link" href="#_how_to_run_meta_release_automatic_mode">How to run meta-release (automatic-mode)</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>All you have to do is run the jar with the releaser and pass the
|
||||
<code>-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>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code>$ 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"</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="admonitionblock important">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-important" title="Important"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
For the meta release the <code>startFrom</code> or <code>taskNames</code> take into consideration
|
||||
the project names, not task names. E.g. you can start from <code>spring-cloud-netflix</code> project,
|
||||
or build only tasks with names <code>spring-cloud-build,spring-cloud-sleuth</code>.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_project_options"><a class="link" href="#_project_options">Project options</a></h3>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>releaser.fixed-versions</code> - A String to String mapping of manually set versions. E.g. <code>"spring-cloud-cli" → "1.0.0.RELEASE"</code> will set
|
||||
the <code>spring-cloud-cli.version</code> to <code>1.0.0.RELEASE</code> regardless of what was set in <code>spring-cloud-release</code> project. Example <code>--releaser.fixed-versions[spring-cloud-cli]=1.0.0.RELEASE</code>.
|
||||
Use these properties to provide versions for the meta release.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.meta-release.enabled</code> - You have to turn it on to enable a meta release. Defaults to <code>false</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>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><a href="https://github.com/spring-cloud" class="bare">https://github.com/spring-cloud</a></code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>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>[spring-boot, spring-cloud-stream, spring-cloud-task]</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.update-documentation-repo</code> - If <code>true</code> then will update documentation repository with the <code>current</code> URL. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.spring-project-url</code> - URL to the documentation Git repository. Defaults to <code><a href="https://github.com/spring-projects/spring-cloud" class="bare">https://github.com/spring-projects/spring-cloud</a></code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.spring-project-branch</code> - Branch to check out for the documentation project. Defaults to <code>gh-pages</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.update-spring-project</code> - If <code>true</code> then will update Project Sagan with the current release train values. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.test-samples-project-url</code> - URL to the test samples to be checked against the given release train. Defaults to <code><a href="https://github.com/spring-cloud/spring-cloud-core-tests" class="bare">https://github.com/spring-cloud/spring-cloud-core-tests</a></code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.test-samples-project-branch</code> - Branch to check out for test samples. Defaults to <code>master</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.release-train-wiki-url</code> - URL to the project’s release train wiki page. Defaults to <code><a href="https://github.com/spring-projects/spring-cloud.wiki.git" class="bare">https://github.com/spring-projects/spring-cloud.wiki.git</a></code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.update-release-train-wiki</code> - If <code>true</code> then will update the release train wiki page with the current release train values. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.run-updated-samples</code> - If <code>true</code> then will update samples and run the the build. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.all-test-samples-urls</code> - URLs to the test samples to be cloned and updated with proper snapshot versions.
|
||||
E.g. <code>"--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.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.update-all-test-samples</code> - If <code>true</code> then will update samples with bumped snapshots after release. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.release-train-docs-url</code> - URL to the release train documentation. Defaults to <code><a href="https://github.com/spring-cloud-sample/scripts" class="bare">https://github.com/spring-cloud-sample/scripts</a></code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.release-train-docs-branch</code> - Branch to check out for release train documentation. Defaults to <code>master</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.update-release-train-docs</code> - If <code>true</code> then will update the release train documentation project and run the generation. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.update-spring-guides</code> - If <code>true</code> then will update Spring Guides with the current release train. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>The following properties are used for both meta release and a release of an individual module.</p>
|
||||
</div>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>releaser.post-release-tasks-only</code> - If set to <code>true</code> will run only post release tasks. Defaults to <code>false</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.meta-release.release-train-project-name</code> - Name of the project that represents the BOM of the release train. Defaults to <code>spring-cloud-release</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>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>[spring-cloud, spring-cloud-dependencies, spring-cloud-starter]</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.fetch-versions-from-git</code> - If <code>true</code> then should fill the map of versions from Git. If <code>false</code> then picks fixed versions.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.clone-destination-dir</code> - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.release-train-bom-url</code> - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: <code><a href="https://github.com/spring-cloud/spring-cloud-release" class="bare">https://github.com/spring-cloud/spring-cloud-release</a></code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.documentation-url</code> - URL to the documentation Git repository. Defaults to <code><a href="https://github.com/spring-cloud/spring-cloud-static" class="bare">https://github.com/spring-cloud/spring-cloud-static</a></code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.documentation-branch</code> - Branch to check out for the documentation project. Defaults to <code>gh-pages</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.sagan.update-sagan</code> - If <code>true</code> then will update project sagan with information about this project. Defaults to <code>true</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.sagan.docs-adocs-file</code> - Folder with asciidoctor files for docs. Defaults to <code>docs/src/main/asciidoc</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.sagan.index-section-file-name</code> - Name of the ascii doc file with core part of this project’s Sagan project page. Will search under <code>releaser.sagan.docs-adocs-file</code> folder.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.sagan.boot-section-file-name</code> - Name of the ascii doc file with boot part of this project’s Sagan project page. Will search under <code>releaser.sagan.docs-adocs-file</code> folder.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.oauth-token</code> - GitHub OAuth token to be used to interact with GitHub repo.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.username</code> - Optional Git username. If not passed keys will be used for authentication.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.git.password</code> - Optional Git password. If not passed keys will be used for authentication.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>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>10</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.maven.build-command</code> - Command to be executed to build the project. Defaults to <code>./mvnw clean install -Pdocs</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.maven.deploy-command</code> - Command to be executed to deploy a built project". Defaults to <code>./mvnw deploy -DskipTests -Pfast</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.maven.publish-docs-commands</code> - Command to be executed to deploy a built project. If present <code>{{version}}</code> will be replaced by the proper version.
|
||||
Defaults to the standard Spring Cloud wget and execution of ghpages.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.maven.system-properties</code> - Additional system properties that should be passed to any commands. If present <code>{{systemProps}}</code> will be replaced by the contents of this property.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.maven.wait-time-in-minutes</code> - Max wait time in minutes for the process to finish. Defaults to <code>20</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.gradle.gradle-props-substitution</code> - a map containing a <code>key</code> which is a property key inside <code>gradle.properties</code> and a <code>value</code> of
|
||||
a project name. E.g. in <code>gradle.properties</code> you have <code>foo=1.0.0.BUILD-SNAPSHOT</code> and you would like <code>spring-cloud-contract</code> version to
|
||||
be set there. Just provide a mapping for the <code>gradle-props-substition</code> looking like this <code>foo=spring-cloud-contract</code> and the result
|
||||
(e.g for sc-contract version <code>2.0.0.RELEASE</code>) will be an updated <code>gradle.properties</code> with entry <code>foo=2.0.0.RELEASE</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.pom.branch</code> - Which branch of Spring Cloud Release should be checked out. Defaults to <code>master</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.pom.pom-with-boot-starter-parent</code> - What is the location of the <code>pom.xml</code> that contains the <code>spring-boot-starter-parent</code> as its parent pom. Defaults to <code>spring-cloud-starter-parent/pom.xml</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.pom.this-train-bom</code> - What is the location of the <code>pom.xml</code> that contains all the versions for the release train. Defaults to <code>spring-cloud-dependencies/pom.xml</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.pom.bom-version-pattern</code> - Regular expression that will match the versions of projects in the BOM pom.xml. Defaults to <code>^(spring-cloud-.*)\.version$</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.pom.ignored-pom-regex</code> - List of regular expressions of ignored poms. Defaults to test projects and samples.
|
||||
Example: <code>"--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>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.working-dir</code> - By default Releaser assumes running the program from the current working directory.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>releaser.template.template-folder</code> - Tells which subfolder with templates to pick for blog, email etc. generation. Defaults to <code>cloud</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="admonitionblock tip">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-tip" title="Tip"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
You can pass the options either via system properties or via application arguments.
|
||||
Example for system properties: <code>java -Dreleaser.pom.branch=Camden.SR6 -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar</code>
|
||||
Example for application arguments: <code>java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="admonitionblock important">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-important" title="Important"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
For the GA release to be successful, it’s important that if the <code>build</code> / <code>deploy</code> command
|
||||
run a script (e.g. <code>scripts/foo.sh</code>) then inside <code>foo.sh</code> if you call a Maven build <code>./mvnw clean install</code>
|
||||
then <strong>remember to pass all arguments of the script there too</strong>. E.g. <code>./mvnw clean install ${@}</code>. That’s because
|
||||
the releaser will pass any system properties to the <code>build</code> / <code>deploy</code> command, such as system properties
|
||||
with keys and we need them to be passed inside the command executed by the releaser.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_examples"><a class="link" href="#_examples">Examples</a></h3>
|
||||
<div class="sect3">
|
||||
<h4 id="_keeping_configuration_in_the_project"><a class="link" href="#_keeping_configuration_in_the_project">Keeping configuration in the project</a></h4>
|
||||
<div class="paragraph">
|
||||
<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>releaser.yml</code> under <code>config</code>
|
||||
folder and run your application like this:</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ wget https://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O ../spring-cloud-release-tools-spring-1.0.0.M1.jar
|
||||
$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --spring.config.name=releaser</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="admonitionblock tip">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-tip" title="Tip"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
Notice that we’re downloading the jar to a parent folder, not to <code>target</code>. That’s because <code>target</code> get cleaned
|
||||
during the build process
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="admonitionblock important">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-important" title="Important"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
For the meta-releaser to work we assume that the path to the
|
||||
configuration file is always <code>config/releaser.yml</code>.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect3">
|
||||
<h4 id="_specifying_a_branch"><a class="link" href="#_specifying_a_branch">Specifying A Branch</a></h4>
|
||||
<div class="paragraph">
|
||||
<p>By deafult the releaser will default to using the <code>master</code> branch of <code>spring-cloud-release</code>.
|
||||
If you would like to use another branch you can specify it using the <code>releaser.pom.branch</code> property.</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ java -jar spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect3">
|
||||
<h4 id="_using_environment_variables"><a class="link" href="#_using_environment_variables">Using Environment Variables</a></h4>
|
||||
<div class="paragraph">
|
||||
<p>In some cases it might be easier to specify environment variables instead of passing parameters to
|
||||
<code>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>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ export RELEASER_POM_BRANCH=Dalston.RELEASE
|
||||
$ export RELEASER_GIT_OAUTH_TOKEN=...
|
||||
$ wget https://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O spring-cloud-release-tools-spring-1.0.0.M1.jar
|
||||
$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.working-dir=/path/to/project/root</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_faq"><a class="link" href="#_faq">FAQ</a></h3>
|
||||
<div class="sect3">
|
||||
<h4 id="_jschexception_auth_fail"><a class="link" href="#_jschexception_auth_fail">JSchException: Auth fail</a></h4>
|
||||
<div class="paragraph">
|
||||
<p>I got such an exception</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code>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</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>To fix that just call</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash"># to run the agent
|
||||
$ eval `ssh-agent`
|
||||
# to store the pass in the agent
|
||||
$ ssh-add ~/.ssh/id_rsa</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>before running the app</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script>
|
||||
<script type="text/javascript" src="js/toc.js"></script>
|
||||
<link rel="stylesheet" href="js/highlight/styles/atom-one-dark-reasonable.min.css">
|
||||
<script src="js/highlight/highlight.min.js"></script>
|
||||
<script>hljs.initHighlighting()</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user