diff options
| author | Kamal Marhubi <kamal@marhubi.com> | 2017-04-16 23:51:18 -0400 |
|---|---|---|
| committer | Kamal Marhubi <kamal@marhubi.com> | 2017-04-16 23:51:18 -0400 |
| commit | 25ce053a2d42a94bcc2c27883eb81c2fe45e5a69 (patch) | |
| tree | 45e4f7cae290d2062b1d52ab0cf376865ad9890a /CONTRIBUTING.md | |
| parent | 2f780ef0052587415e2a3dfe934acc0e30eebee0 (diff) | |
| download | nix-25ce053a2d42a94bcc2c27883eb81c2fe45e5a69.zip | |
ci: Allow skipping tests when running under CI
This adds `--cfg=travis` to builds under CI, allowing tests to be
conditionally ignored by marking them with
#[cfg_attr(travis, ignore)]
refs #568
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d8b8ded..03a1f630 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,6 +85,13 @@ locally. More information is available in the [CI Readme][ci-readme]. [travis-ci]: https://travis-ci.org/nix-rust/nix [ci-readme]: ci/README.md +### Disabling a test in the CI environment + +Sometimes there are features that cannot be tested in the CI environment. +To stop a test from running under CI, add `#[cfg_attr(travis, ignore)]` +to it. Please include a comment describing the reason it shouldn't run +under CI, and a link to an upstream issue if possible! + ## bors, the bot who merges all the PRs All pull requests are merged via [bors], an integration bot. After the |