| Zhiyi Zhang | 8617a79 | 2017-01-17 16:45:56 -0800 | [diff] [blame] | 1 | CONTINUOUS INTEGRATION SCRIPTS |
| 2 | ============================== |
| 3 | |
| 4 | Environment 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 | |
| 12 | Possible values for Linux: |
| 13 | |
| 14 | * `[OS_TYPE]`: `Linux` |
| 15 | * `[DISTRO_TYPE]`: `Ubuntu` |
| Davide Pesavento | bccde32 | 2018-08-18 14:10:25 -0400 | [diff] [blame] | 16 | * `[DISTRO_VERSION]`: `Ubuntu-16.04`, `Ubuntu-18.04` |
| Zhiyi Zhang | 8617a79 | 2017-01-17 16:45:56 -0800 | [diff] [blame] | 17 | |
| 18 | Possible values for OS X / macOS: |
| 19 | |
| 20 | * `[OS_TYPE]`: `OSX` |
| 21 | * `[DISTRO_TYPE]`: `OSX` (can be absent) |
| Davide Pesavento | bccde32 | 2018-08-18 14:10:25 -0400 | [diff] [blame] | 22 | * `[DISTRO_VERSION]`: `OSX-10.11`, `OSX-10.12`, `OSX-10.13` |
| Zhiyi Zhang | 8617a79 | 2017-01-17 16:45:56 -0800 | [diff] [blame] | 23 | |
| 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 |
| ashiqopu | 83ad2c0 | 2018-11-25 06:49:52 +0000 | [diff] [blame^] | 30 | * `code-coverage` (Ubuntu Linux is assumed): debug build with tests and code coverage analysis |
| Zhiyi Zhang | 8617a79 | 2017-01-17 16:45:56 -0800 | [diff] [blame] | 31 | * `limited-build`: only a single debug build with tests |
| 32 | |
| 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 Pesavento | cf9ffe4 | 2018-01-21 22:21:53 -0500 | [diff] [blame] | 35 | |
| 36 | - `WAF_JOBS`: number of parallel build jobs used by waf, defaults to 1. |