From e5b8d638ea7293ae8a6d65386aefbb0d30aa254c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 28 Aug 2017 16:36:33 +0200 Subject: Update user guide --- guide/ci.html | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) (limited to 'guide/ci.html') diff --git a/guide/ci.html b/guide/ci.html index 73b786c..b04e610 100644 --- a/guide/ci.html +++ b/guide/ci.html @@ -33,7 +33,37 @@ div.navfooter{margin-bottom:1em}
-

Chapter 19. Continuous integration

Placeholder chapter.

+

Chapter 20. Continuous integration

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 OTP version pinning +Section 12.2, “OTP version pinning” +section of the OTP version management +Chapter 12, OTP version management chapter.)

20.1. Configuring Erlang/OTP versions to test

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.

At the time of writing, this is how you would test against all +the most recent patch releases of Erlang/OTP 19 and above:

CI_OTP = OTP-19.0.7 OTP-19.1.6 OTP-19.2.3 OTP-19.3.6.2 OTP-20.0.4

If you want to test against HiPE and ErLLVM but only with the +latest version of Erlang/OTP, the following could work:

CI_HIPE = $(lastword $(CI_OTP))
+CI_ERLLVM = $(CI_HIPE)

Consult the OTP version management +Chapter 12, OTP version management chapter for more +information about Erlang/OTP versions and customization of the +Erlang/OTP builds.

20.2. Running tests across all configured versions

The recommended way to run the ci target is with the option +-k. It will ensure that tests are run for all configured +Erlang/OTP versions, even if there are errors:

$ make ci -k

20.3. Extending the CI targets

The ci target can be extended. For example to run Dialyzer +at the end of CI:

+ci +
+dialyze +

Additional setup can be done by extending the ci-setup +target. This target is ran before testing each individual +Erlang/OTP version.

For example, to ensure dependencies are re-fetched/built +before testing individual Erlang/OTP releases:

+ci-setup +
+distclean +

Similarly, the ci-extra target can be extended to run +extra commands after an Erlang/OTP version has been tested.

-- cgit v1.2.3