From 838513a05aa8f853d1fbc9bd42ca0b1205b8ca99 Mon Sep 17 00:00:00 2001 From: Matt Rendina Date: Tue, 18 Sep 2018 10:09:34 -0400 Subject: Clarify env_vars cases. Add example. --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 29e097a..73887bb 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,10 @@ configure_cmd = "yes '' | ./waf configure --prefix=./_install ${DEFAULT_FLAGS}" bc0 = new BuildConfig() bc0.nodetype = "linux-stable" bc0.name = "debug" -bc0.env_vars = ['PATH=./_install/bin:$PATH'] +LOCAL_VARIABLE='use_me_now' +bc0.env_vars = ['MY_VAR=' + LOCAL_VARIABLE, // (Early expansion) Compose string locally, then pass to environment. + 'PATH=./_install/bin:$PATH', // (Late expansion) $PATH gets expanded later by the shell hosting the build. + ] bc0.build_cmds = ["${configure_cmd} --debug", "./waf build", "./waf install"] @@ -78,8 +81,8 @@ It has the following members: | `conda_packages` | list of strings | no | If this list is defined, the associated build job will create a temporary conda environment to host the job which contains the packages specified. Package specifications are of the form Example: `bc0.conda_packages = ["pytest", "requests", "numpy=1.14.3"]` | | `conda_override_channels` | boolean | no | Instructs the conda environment creation process to not implicitly prepend the anaconda defaults channel to the list of channels used. This allows the priority of channels to be used for environment creation to be specified exactly in the order of channels provided in the `conda_channels` list, described below. If `conda_packages` is not defined in the Jenkinsfile this property is ignored. | | `conda_channels` | list of strings | no | The list of channels, in order of search priority, to use when retrieving packages for installation. If `conda_override_channels` is not defined, this list will have the conda `defaults` channel implicitly prepended to it at installation time. If `conda_packages` is not defined in the Jenkinsfile this property is ignored. Example: `bc0.conda_channels = ["http://ssb.stsci.edu/astroconda"]` | - | `conda_ver` | string | no | The version of conda to use when creating environments to host the build. If not supplied, the latest available version of conda will be obtained. NOTE: This may chage from build to build, depending on the state of conda releases. | - | `env_vars` | list of strings | no | Allow configuration of the shell environment in which build and test commands are run. Noteworthy behaviors: | + | `conda_ver` | string | no | The version of conda to use when creating environments to host the build. If not supplied, a recent version of conda will be obtained. | + | `env_vars` | list of strings | no | Allow configuration of the shell environment in which build and test commands are run. Of note: | | `build_cmds` | list of strings | yes | These commands are run in their order of appearance in this list with the default shell environment and any modifications to that environment provided by the `env_vars` list described above. | | `test_cmds` | list of strings | no | These commands are run in their order of appearance in this list with the default shell environment plus any modifications to that environment provided by the `env_vars` list described above. | | `failedFailureNewThresh` | integer | no | (Default is no threshold set.) The threshold for the number of newly appearing test failures that will cause the build to be flagged as "FAILED". | -- cgit