docs
[m6w6/btr] / README.md
1 # btr
2
3 ## BUILD TEST REPORT
4
5 A simple tool to automate reporting of build and test results.
6
7 ### Currently supported rulesets:
8
9 * source: git, svn
10 * build: php, pecl
11 * report: mail
12
13 #### Usage
14 ```
15 Usage: btr [-hv] [<options>] <repository>
16
17 -h, --help Display this help
18 -v, --verbose Be more verbose
19
20 Options:
21 -s, --source=<rules> Use the specified source ruleset
22 -b, --build=<rules> Use the specified build ruleset
23 -r, --report=<rules> Use the specifued report ruleset
24 -B, --branch=<branch> Checkout this branch
25 -D, --directory=<directory> Use this directory as work root
26 -S, --suffix=<suffix> Append suffix to the build name
27 -C, --configure=<options> Define $CONFIGURE options
28
29 Rulesets:
30 source: git
31 build: php
32 report: mail
33 ```
34 #### Examples
35
36 `USER=mike@php.net ./bin/btr -s svn -b pecl -r mail -v https://svn.php.net/repository/pecl/http -B branches/DEV_2`
37
38 `USER=mike@php.net TESTS=tests/output ./bin/btr -s git -b php -r mail git@git.php.net:php-src.git`
39