aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorÉrico Rolim <erico.erc@gmail.com>2021-01-30 00:47:59 +0000
committerÉrico Nogueira Rolim <34201958+ericonr@users.noreply.github.com>2021-02-11 05:40:09 +0000
commit2a748e7e6d9727a7e921d6b9a163e0eb17be98b9 (patch)
tree9130b04f4868a8baa76b2c4813eaa8530b1a5ccf /CONTRIBUTING.md
parent42d75969811c78eb1df9fcdd5f831c0d2aedcde4 (diff)
downloadvoid-packages-2a748e7e6d9727a7e921d6b9a163e0eb17be98b9.tar
void-packages-2a748e7e6d9727a7e921d6b9a163e0eb17be98b9.tar.gz
void-packages-2a748e7e6d9727a7e921d6b9a163e0eb17be98b9.tar.bz2
void-packages-2a748e7e6d9727a7e921d6b9a163e0eb17be98b9.tar.lz
void-packages-2a748e7e6d9727a7e921d6b9a163e0eb17be98b9.tar.xz
void-packages-2a748e7e6d9727a7e921d6b9a163e0eb17be98b9.tar.zst
void-packages-2a748e7e6d9727a7e921d6b9a163e0eb17be98b9.zip
xbps-src/libexec: add make_check option.
Allows a template to define in which circumstances its do_check phase should run, without requiring custom do_check definitions in each template (also makes it easier to change how build styles do things without checking as many templates). Add to Manual and CONTRIBUTING as well.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cd3d6aad5dd..d6a7299f64b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -87,11 +87,15 @@ When you make changes to your pull request, please *do not close and reopen your
#### Continuous Integration
-Pull requests are automatically submitted for Continuous Integration (CI) testing to ensure packages build on various combinations of libc and architecture.
+Pull requests are automatically submitted for Continuous Integration (CI) testing to ensure packages build and pass their tests (on native builds) on various combinations of C library and architecture.
Packages that take longer than 120 minutes or need more than 14G of storage to complete their build (for example, Firefox or the Linux kernel) will fail CI and should include `[ci skip]` in the PR title or body (the comment field when the PR is being opened) to avoid wasting CI builder time.
Use your best judgment on build times based on your local building experience. If you skip CI when submitting a PR, please build and cross-build for a variety of architectures locally, with both glibc and musl, and note your local results in PR comments.
Make sure to cover 64-bit and 32-bit architectures.
+If you notice a failure in CI that didn't happen locally, that is likely because you didn't run tests locally.
+Use `./xbps-src -Q pkg <package>` to do so.
+Some tests won't work in the CI environment or at all, and their templates should encode this information using the `make_check` variable.
+
Continuous Integration will also check if the templates you have changed
comply with the our guidelines. At the moment not all packages comply with the rules, so if you update a package, it may report errors about places you haven't touched. Please feel free to fix those errors too.