From c39e2a686539689817939b8b390c22559c8e46a3 Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Sat, 3 Feb 2018 09:37:37 -0500 Subject: [PATCH] Document the automatic building of PRs --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index b7bf170..9f3a12e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,20 @@ 2. be gentle, preferably don't run mass rebuilds / massive builds like chromium on it +## Automatic Building + +Users who are _trusted_ (see: ./config.public.json) will have their +PRs automatically trigger builds if their commits follow the +well-defined format of Nixpkgs. Example messages and the builds: + +|Message|Automatic Build| +|-|-| +|`vim: 1.0.0 -> 2.0.0`|`vim`| +|`python3Packages.requests,python2Packages.requests: 1.0.0 -> 2.0.0`|`python3Packages.requests`, `python2Packages.requests`| +|`python{2,3}Packages.requests: 1.0.0 -> 2.0.0`|_nothing_| + + + ## Commands The comment parser is line-based, so comments can be interleaved with