blob: e8dbf374cd81dfe6f8b466fac3d3e35af20642f5 [file] [log] [blame] [view]
Davide Pesaventoec61b742020-04-18 01:00:12 -04001# CONTINUOUS INTEGRATION SCRIPTS
Alexander Afanasyev6e64ac92018-06-14 17:25:38 -04002
Davide Pesaventoec61b742020-04-18 01:00:12 -04003## Environment Variables Used in Build Scripts
Alexander Afanasyev6e64ac92018-06-14 17:25:38 -04004
Davide Pesaventoec61b742020-04-18 01:00:12 -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 Afanasyev6e64ac92018-06-14 17:25:38 -04007
Davide Pesaventoec61b742020-04-18 01:00:12 -04008 The list should normally contain `[OS_TYPE]`, `[DISTRO_TYPE]`, and `[DISTRO_VERSION]`.
Alexander Afanasyev6e64ac92018-06-14 17:25:38 -04009
Davide Pesaventoec61b742020-04-18 01:00:12 -040010 Example values:
Alexander Afanasyev6e64ac92018-06-14 17:25:38 -040011
Davide Pesaventoec61b742020-04-18 01:00:12 -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 Afanasyev6e64ac92018-06-14 17:25:38 -040015
Davide Pesaventoec61b742020-04-18 01:00:12 -040016- `JOB_NAME`: optional variable that defines the type of build job. Depending on the job type,
Alexander Afanasyev6e64ac92018-06-14 17:25:38 -040017 the build scripts can perform different tasks.
18
19 Possible values:
20
Davide Pesaventoec61b742020-04-18 01:00:12 -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
Alexander Afanasyev6e64ac92018-06-14 17:25:38 -040024
Davide Pesaventoec61b742020-04-18 01:00:12 -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.
Alexander Afanasyev6e64ac92018-06-14 17:25:38 -040027
Davide Pesaventoec61b742020-04-18 01:00:12 -040028- `WAF_JOBS`: number of parallel build threads used by waf, defaults to 1.