aboutsummaryrefslogtreecommitdiffstats
path: root/guide/ci.html
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-04 12:04:40 +0200
committerLoïc Hoguin <[email protected]>2018-06-04 12:04:40 +0200
commit4684b443bbe71bd9b7acd7a4b5aec5160031ae71 (patch)
tree164bee29e055c40a176b568b0076627602632266 /guide/ci.html
parent75a6ce5f30ab530b2f38ea06262cff0d3a78643a (diff)
downloaderlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.tar.gz
erlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.tar.bz2
erlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.zip
Update user guide
Diffstat (limited to 'guide/ci.html')
-rw-r--r--guide/ci.html13
1 files changed, 5 insertions, 8 deletions
diff --git a/guide/ci.html b/guide/ci.html
index 5705b07..998c3cf 100644
--- a/guide/ci.html
+++ b/guide/ci.html
@@ -33,24 +33,21 @@ div.navfooter{margin-bottom:1em}
</header>
<main>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="coverage.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="dialyzer.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="ci"></a>Chapter 21. Continuous integration</h2></div></div></div><p>Erlang.mk comes with some support for continuous integration,
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="coverage.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="dialyzer.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="ci"></a>Chapter 22. Continuous integration</h2></div></div></div><p>Erlang.mk comes with some support for continuous integration,
aimed at open source projects that need to support more than
one specific Erlang/OTP release. (If you target one specific
release, check the <a class="link" href="kerl.html#otp_version_pinning" title="12.2. OTP version pinning">OTP version pinning</a>
-<a class="xref" href="kerl.html#otp_version_pinning" title="12.2. OTP version pinning">Section 12.2, “OTP version pinning”</a>
-section of the <a class="link" href="kerl.html" title="Chapter 12. OTP version management">OTP version management</a>
-<a class="xref" href="kerl.html" title="Chapter 12. OTP version management">Chapter 12, <em>OTP version management</em></a> chapter.)</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuring_erlang_otp_versions_to_test"></a>21.1. Configuring Erlang/OTP versions to test</h2></div></div></div><p>To use the CI plugin you must first configure which versions
+section of the <a class="link" href="kerl.html" title="Chapter 12. OTP version management">OTP version management</a> chapter.)</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuring_erlang_otp_versions_to_test"></a>22.1. Configuring Erlang/OTP versions to test</h2></div></div></div><p>To use the CI plugin you must first configure which versions
of Erlang/OTP will be used. Erlang.mk provides three separate
configuration variables depending on whether you need a normal
OTP release, a HiPE-enabled release or an ErLLVM-enabled release.</p><p>At the time of writing, this is how you would test against all
the most recent patch releases of Erlang/OTP 19 and above:</p><pre class="programlisting">CI_OTP = OTP-19.0.7 OTP-19.1.6 OTP-19.2.3 OTP-19.3.6.2 OTP-20.0.4</pre><p>If you want to test against HiPE and ErLLVM but only with the
latest version of Erlang/OTP, the following could work:</p><pre class="programlisting">CI_HIPE = $(lastword $(CI_OTP))
-CI_ERLLVM = $(CI_HIPE)</pre><p>Consult the <a class="link" href="kerl.html" title="Chapter 12. OTP version management">OTP version management</a>
-<a class="xref" href="kerl.html" title="Chapter 12. OTP version management">Chapter 12, <em>OTP version management</em></a> chapter for more
+CI_ERLLVM = $(CI_HIPE)</pre><p>Consult the <a class="link" href="kerl.html" title="Chapter 12. OTP version management">OTP version management</a> chapter for more
information about Erlang/OTP versions and customization of the
-Erlang/OTP builds.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_running_tests_across_all_configured_versions"></a>21.2. Running tests across all configured versions</h2></div></div></div><p>The recommended way to run the <code class="literal">ci</code> target is with the option
+Erlang/OTP builds.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_running_tests_across_all_configured_versions"></a>22.2. Running tests across all configured versions</h2></div></div></div><p>The recommended way to run the <code class="literal">ci</code> target is with the option
<code class="literal">-k</code>. It will ensure that tests are run for all configured
-Erlang/OTP versions, even if there are errors:</p><pre class="programlisting">$ make ci -k</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_extending_the_ci_targets"></a>21.3. Extending the CI targets</h2></div></div></div><p>The <code class="literal">ci</code> target can be extended. For example to run Dialyzer
+Erlang/OTP versions, even if there are errors:</p><pre class="programlisting">$ make ci -k</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_extending_the_ci_targets"></a>22.3. Extending the CI targets</h2></div></div></div><p>The <code class="literal">ci</code> target can be extended. For example to run Dialyzer
at the end of CI:</p><pre class="programlisting">ci:: dialyze</pre><p>Additional setup can be done by extending the <code class="literal">ci-setup</code>
target. This target is ran before testing each individual
Erlang/OTP version.</p><p>For example, to ensure dependencies are re-fetched/built