blob: 39fa40bd7b927b29a43847b45545623066fe0253 [file] [log] [blame] [view]
Alexander Afanasyevb81cff92015-07-09 09:45:09 +08001CONTINUOUS INTEGRATION SCRIPTS
2==============================
3
4Environment Variables Used in Build Scripts
5-------------------------------------------
6
7- `NODE_LABELS`: the variable defines a list of OS properties. The set values are used by the
8 build scripts to select proper behavior for different OS.
9
10 The list should include at least `[OS_TYPE]`, `[DISTRO_TYPE]`, and `[DISTRO_VERSION]`.
11
Eric Newberry81a9a862016-12-27 22:59:27 -070012 Possible values for Linux:
Alexander Afanasyevb81cff92015-07-09 09:45:09 +080013
14 * `[OS_TYPE]`: `Linux`
15 * `[DISTRO_TYPE]`: `Ubuntu`
Davide Pesavento5f35f642018-05-10 19:36:03 -040016 * `[DISTRO_VERSION]`: `Ubuntu-16.04`, `Ubuntu-18.04`
Alexander Afanasyevb81cff92015-07-09 09:45:09 +080017
Eric Newberry81a9a862016-12-27 22:59:27 -070018 Possible values for OS X / macOS:
Alexander Afanasyevb81cff92015-07-09 09:45:09 +080019
20 * `[OS_TYPE]`: `OSX`
21 * `[DISTRO_TYPE]`: `OSX` (can be absent)
Davide Pesavento5f35f642018-05-10 19:36:03 -040022 * `[DISTRO_VERSION]`: `OSX-10.11`, `OSX-10.12`, `OSX-10.13`
Alexander Afanasyevb81cff92015-07-09 09:45:09 +080023
24- `JOB_NAME`: optional variable to define type of the job. Depending on the defined job type,
25 the build scripts can perform different tasks.
26
27 Possible values:
28
29 * empty: default build process
Eric Newberry81a9a862016-12-27 22:59:27 -070030 * `code-coverage` (Linux OS is assumed): debug build with tests and code coverage analysis
31 * `limited-build`: only a single debug build with tests
Alexander Afanasyevf22ebaf2015-12-17 21:23:05 -080032
33- `CACHE_DIR`: the variable defines a path to folder containing cached files from previous builds,
34 e.g., a compiled version of ndn-cxx library. If not set, `/tmp` is used.
Davide Pesavento9ac95d32017-07-01 01:51:37 -040035
36- `WAF_JOBS`: number of parallel build jobs used by waf, defaults to 1.