diff options
author | Matt Rendina <rendinam@users.noreply.github.com> | 2019-03-08 11:44:55 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-03-08 11:44:55 -0500 |
commit | cf8bb87be6b64700ac67cfa02af922f76786c290 (patch) | |
tree | 6f6719c1751c1d06fedc2ff377cd455f7a1e22e4 /README.md | |
parent | 93e64011d54e1b305472926e17768e634e560230 (diff) | |
download | jscu_refactor-cf8bb87be6b64700ac67cfa02af922f76786c290.tar.gz |
conda environment list publication capability (#37)1.3.7
* Add support for publishing conda environment specs to artifactory.
* Add docs for env publication feature
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -89,7 +89,9 @@ It has the following properties: | Member | Type | Required | Purpose | | --- | --- | --- | --- | -| `post_test_summary` | boolean | no | When `true`, will cause the creation of a Github issue on the project's repository containing a summary of test results produced by all build configurations hosted in the the job if any tests returned a `failure` or `error` status. Default is false, meaning no summary issues will be created upon test failures or errors. When set to `true`, if no test failures or errors occur, a summary post will not be generated. | +| `post_test_summary` | boolean | no | When `true`, will cause the creation of a Github issue on the project's repository containing a summary of test results produced by all build configurations hosted in the the job if any tests returned a `failure` or `error` status. Default is false, meaning no summary issues will be created upon test failures or errors. When set to `true`, if no test failures or errors occur, a summary post will not be generated. Default value when not specified or no jobconfig object passed to `run()`: `false` | +| `enable_env_publication` | boolean | no | When `true`, and when conda is used during the job (for instance when a `conda_packages` list is provided in a build config), every build configuration (See BuildConfig Class below) that produces an XML test report with no test failures will also publish a list of the environment's packages to an Artifactory repository defined in either a `setup.cfg [tool:pytest]` section _OR_ in a `pytest.ini` file (but not both) using the `results_root` configuration value. i.e. `results_root = <artifactory destination repo>` The environment list file produced is the result of the command `conda list --explicit` from within the active environment and will be named `conda_env_dump_<value of buildconfig.name>.txt`. Note: the Artifactory repository specified must be configured to allow files to be published there. Default value when not specified or no jobconfig object passed to `run()`: `false` | +| `publish_env_on_success_only` | boolean | no | When `enable_env_publication` is set to true, a `false` value for this option will publish a package list of any conda environments that are used in each build configuration, even if the test results contain failures. Default value when not specified or no jobconfig object passed to `run()`: `true` | #### Test Summary Issue Posts If test summaries are requested using the `post_test_summary` property of the JobConfig class as described above, each Jenkins job that produces one or more test errors or failures will result in a single new Github issue being posted to the project's repository. |