blob: 6cba1e477f772a9b74e992aef0ff3bf110859424 [file] [log] [blame] [view]
Joao Pereiraef326da2015-05-27 18:27:40 -04001CONTINUOUS 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 Newberry9737aa82016-12-27 23:03:49 -070012 Possible values for Linux:
Joao Pereiraef326da2015-05-27 18:27:40 -040013
14 * `[OS_TYPE]`: `Linux`
15 * `[DISTRO_TYPE]`: `Ubuntu`
Davide Pesavento26ea1ac2018-05-10 20:20:03 -040016 * `[DISTRO_VERSION]`: `Ubuntu-16.04`, `Ubuntu-18.04`
Joao Pereiraef326da2015-05-27 18:27:40 -040017
Davide Pesavento9fa6a782020-03-10 19:47:06 -040018 Possible values for macOS:
Joao Pereiraef326da2015-05-27 18:27:40 -040019
20 * `[OS_TYPE]`: `OSX`
21 * `[DISTRO_TYPE]`: `OSX` (can be absent)
Davide Pesavento9fa6a782020-03-10 19:47:06 -040022 * `[DISTRO_VERSION]`: `OSX-10.12`, `OSX-10.13`, `OSX-10.14`
Joao Pereiraef326da2015-05-27 18:27:40 -040023
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
ashiqopu1f0cad72018-11-25 01:22:54 +000030 * `code-coverage` (Ubuntu Linux is assumed): debug build with tests and code coverage analysis
Eric Newberry9737aa82016-12-27 23:03:49 -070031 * `limited-build`: only a single debug build with tests
Davide Pesavento956ac312016-09-20 19:11:30 +020032
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 Pesavento44660cf2017-08-16 00:44:23 -040035
36- `WAF_JOBS`: number of parallel build jobs used by waf, defaults to 1.