blob: e8dbf374cd81dfe6f8b466fac3d3e35af20642f5 [file] [log] [blame] [view]
Davide Pesaventofee7ee32020-04-15 02:45:07 -04001# CONTINUOUS INTEGRATION SCRIPTS
Alexander Afanasyevc7c99002015-10-09 17:27:30 -07002
Davide Pesaventofee7ee32020-04-15 02:45:07 -04003## Environment Variables Used in Build Scripts
Alexander Afanasyevc7c99002015-10-09 17:27:30 -07004
Davide Pesaventofee7ee32020-04-15 02:45:07 -04005- `NODE_LABELS`: space-separated list of platform properties. The included values are used by
6 the build scripts to select the proper behavior for different operating systems and versions.
Alexander Afanasyevc7c99002015-10-09 17:27:30 -07007
Davide Pesaventofee7ee32020-04-15 02:45:07 -04008 The list should normally contain `[OS_TYPE]`, `[DISTRO_TYPE]`, and `[DISTRO_VERSION]`.
Alexander Afanasyevc7c99002015-10-09 17:27:30 -07009
Davide Pesaventofee7ee32020-04-15 02:45:07 -040010 Example values:
Alexander Afanasyevc7c99002015-10-09 17:27:30 -070011
Davide Pesaventofee7ee32020-04-15 02:45:07 -040012 - `[OS_TYPE]`: `Linux`, `OSX`
13 - `[DISTRO_TYPE]`: `Ubuntu`, `CentOS`
14 - `[DISTRO_VERSION]`: `Ubuntu-16.04`, `Ubuntu-18.04`, `CentOS-8`, `OSX-10.14`, `OSX-10.15`
Alexander Afanasyevc7c99002015-10-09 17:27:30 -070015
Davide Pesaventofee7ee32020-04-15 02:45:07 -040016- `JOB_NAME`: optional variable that defines the type of build job. Depending on the job type,
Alexander Afanasyevc7c99002015-10-09 17:27:30 -070017 the build scripts can perform different tasks.
18
19 Possible values:
20
Davide Pesaventofee7ee32020-04-15 02:45:07 -040021 - empty: default build task
22 - `code-coverage`: debug build with tests and code coverage analysis (Ubuntu Linux is assumed)
23 - `limited-build`: only a single debug build with tests
Davide Pesavento90034832018-05-30 10:10:31 -040024
Davide Pesaventofee7ee32020-04-15 02:45:07 -040025- `CACHE_DIR`: directory containing cached files from previous builds, e.g., a compiled version
26 of ndn-cxx. If not set, `/tmp` is used.
Davide Pesavento90034832018-05-30 10:10:31 -040027
Davide Pesaventofee7ee32020-04-15 02:45:07 -040028- `WAF_JOBS`: number of parallel build threads used by waf, defaults to 1.