@@ -104,6 +104,7 @@ <h2 id="-≡-contents"><a id="contents"></a> <a href="#contents">≡</a> <a href
104104< li > < a href ="#codecov "> < code > CODECOV=0|1</ code > </ a > </ li >
105105< li > < a href ="#format_check "> < code > FORMAT_CHECK=1|0</ code > </ a > </ li >
106106< li > < a href ="#install_wait "> < code > INSTALL_WAIT=0|1</ code > </ a > </ li >
107+ < li > < a href ="#upgrade_check "> < code > UPGRADE_CHECK=1|0</ code > </ a > </ li >
107108</ ul >
108109</ li >
109110< li > < a href ="#variables "> Variables</ a > < ul >
@@ -451,7 +452,8 @@ <h4 id="-≡-add_conventional_librarylibrary_name_library_version"><a id="add_co
451452< h2 id ="-≡-travis-ci "> < a id ="travis-ci "> </ a > < a href ="#contents "> ≡</ a > < a href ="#travis-ci "> Travis CI</ a > </ h2 >
452453< p > A < a target ="_blank " href ="https://travis-ci-ci.org/ "> Travis CI < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a >
453454< a target ="_blank " href ="https://github.com/cppsm/cppsm-cli/blob/master/.travis.yml "> configuration file < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a >
454- is provided to build and test both < code > Debug</ code > and < code > Release</ code > builds on various OS
455+ and < a target ="_blank " href ="https://github.com/cppsm/cppsm-cli/blob/master/travis-ci "> CI script < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > is
456+ provided to build and test both < code > Debug</ code > and < code > Release</ code > builds on various OS
455457(Linux, OS X, Windows) and compiler configurations
456458(< a target ="_blank " href ="https://clang.llvm.org/ "> Clang < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > , < a target ="_blank " href ="https://gcc.gnu.org/ "> GCC < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > ,
457459< a target ="_blank " href ="https://docs.microsoft.com/en-us/cpp/ "> Visual C++ < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > ). Just add your project to
@@ -473,22 +475,29 @@ <h2 id="-≡-travis-ci"><a id="travis-ci"></a> <a href="#contents">≡</a> <a hr
473475</ ul >
474476</ li >
475477</ ul >
476- < h3 id ="-≡-codecov01 "> < a id ="codecov "> </ a > < a href ="#contents "> ≡</ a > < a href ="#codecov "> < code > CODECOV=0|1</ code > </ a > </ h3 >
477- < p > By default the
478- < a target ="_blank " href ="https://github.com/cppsm/cppsm-cli/blob/master/travis-ci "> CI script < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > does not
479- generate and push code coverage results to < a target ="_blank " href ="https://codecov.io/ "> Codecov < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > . Set
480- < code > CODECOV=1</ code > to enable code coverage.</ p >
481- < h3 id ="-≡-format_check10 "> < a id ="format_check "> </ a > < a href ="#contents "> ≡</ a > < a href ="#format_check "> < code > FORMAT_CHECK=1|0</ code > </ a > </ h3 >
482- < p > By default the
483- < a target ="_blank " href ="https://github.com/cppsm/cppsm-cli/blob/master/travis-ci "> CI script < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > checks
484- that source files have been formatted as with < code > cppsm format</ code > . Set
485- < code > FORMAT_CHECK=0</ code > explicitly to disable the format check.</ p >
486- < h3 id ="-≡-install_wait01 "> < a id ="install_wait "> </ a > < a href ="#contents "> ≡</ a > < a href ="#install_wait "> < code > INSTALL_WAIT=0|1</ code > </ a > </ h3 >
487- < p > By default the
488- < a target ="_blank " href ="https://github.com/cppsm/cppsm-cli/blob/master/travis-ci "> CI script < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > performs
489- installation of additional packages concurrently with builds when possible. Set
490- < code > INSTALL_WAIT=1</ code > to wait for installations to complete before starting any
491- builds.</ p >
478+ < p > Configuration variables:</ p >
479+ < ul >
480+ < li > < p > < a id ="codecov "> </ a > < a href ="#codecov "> < code > CODECOV=0|1</ code > </ a > specifies whether a code
481+ coverage test is executed and results are pushed to
482+ < a target ="_blank " href ="https://codecov.io/ "> Codecov < i class ="fas fa-xs fa-external-link-alt "> </ i > </ a > . Set < code > CODECOV=1</ code > explicitly to enable code
483+ coverage.</ p >
484+ </ li >
485+ < li > < p > < a id ="format_check "> </ a > < a href ="#format_check "> < code > FORMAT_CHECK=1|0</ code > </ a > specifies whether
486+ to check that source files are formatted as with
487+ < a href ="#cppsm-format "> < code > cppsm format</ code > </ a > . Set < code > FORMAT_CHECK=0</ code > explicitly to disable
488+ the format check.</ p >
489+ </ li >
490+ < li > < p > < a id ="install_wait "> </ a > < a href ="#install_wait "> < code > INSTALL_WAIT=0|1</ code > </ a > specifies whether
491+ installation of additional packages is performed concurrently with builds when
492+ possible. Set < code > INSTALL_WAIT=1</ code > explicitly to wait for installations to
493+ complete before starting any builds.</ p >
494+ </ li >
495+ < li > < p > < a id ="upgrade_check "> </ a > < a href ="#upgrade_check "> < code > UPGRADE_CHECK=1|0</ code > </ a > specifies
496+ whether, after running tests, a < a href ="#cppsm-upgrade "> < code > cppsm upgrade</ code > </ a > is performed
497+ and, if something is upgraded, tests are rerun. Set < code > UPGRADE_CHECK=0</ code >
498+ explicitly to skip the upgrade and conditional rerun of tests.</ p >
499+ </ li >
500+ </ ul >
492501< h2 id ="-≡-variables "> < a id ="variables "> </ a > < a href ="#contents "> ≡</ a > < a href ="#variables "> Variables</ a > </ h2 >
493502< p > Several environment variables can be set to change the default behavior of one
494503or more cppsm commands. These variables can be used both on the < a href ="#travis-ci "> CI</ a >
0 commit comments