aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAleksey Filippov <alekseyf@google.com>2018-02-20 15:11:48 +0000
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-02-20 21:21:18 +0530
commit79865474c72b6b7ac32586b683644b78adfff778 (patch)
tree309b06bcb7480753cea4d6e73e6132e74ec0bfe9
parenta374eb08e90378719eb2c82ec46456dedeaa5371 (diff)
downloadmeson-79865474c72b6b7ac32586b683644b78adfff778.zip
meson-79865474c72b6b7ac32586b683644b78adfff778.tar.gz
meson-79865474c72b6b7ac32586b683644b78adfff778.tar.bz2
Add references to CI and recommendation to disable them for doc only changes [skip ci]
-rw-r--r--docs/markdown/Contributing.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md
index 293b629..8e9847a 100644
--- a/docs/markdown/Contributing.md
+++ b/docs/markdown/Contributing.md
@@ -63,6 +63,21 @@ actually work should be done with a unit test.
Projects needed by unit tests are in the `test cases/unit`
subdirectory. They are not run as part of `./run_project_tests.py`.
+### Skipping integration tests
+
+Meson uses several continuous integration testing systems that have slightly
+different interface. To promote consistent naming policy, use:
+
+- `[skip ci]` in the commit title if you want to disable all integration tests
+- `[skip appveyor]` in the commit title if you want to disable Windows-only tests
+
+Continuous integration systems currently used:
+
+- [Travis-CI](https://docs.travis-ci.com/user/customizing-the-build/#Skipping-a-build)
+ allows `[skip ci]` anywhere in the commit messages.
+- [AppVeyor](https://www.appveyor.com/docs/how-to/filtering-commits/#skip-directive-in-commit-message)
+ requires `[skip ci]` or `[skip appveyor]` in the commit title.
+
## Documentation
The `docs` directory contains the full documentation that will be used
@@ -76,6 +91,11 @@ notes. These features should be written in standalone files in the
`docs/markdown/snippets` directory. The release manager will combine
them into one page when doing the release.
+[Integration tests should be disabled](#skipping-integration-tests) for
+documentation-only commits by putting `[skip ci]` into commit title.
+Reviewers should ask contributors to put `[skip ci]` into the title because
+tests are run again after merge for `master`.
+
## Python Coding style
Meson follows the basic Python coding style. Additional rules are the