Skip to content

Commit f96ddac

Browse files
committed
Improve doc
1 parent 58dcb0f commit f96ddac

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,20 @@ Options
3737
-c, --context CONTEXT context to set on comment EXAMPLE: CONTEXT: python-test
3838
-d, --description DESCRIPTION description to set on comment
3939
-t, --test TEST.SH fullpath to the script which contain test to be executed against the pr
40-
-f, --file '.py' specify the file type of the pr which you wantto run the test against ex .py, .java, .rb
40+
-f, --file '.py' specify the file type of the pr which you want to run the test against ex .py, .java, .rb
4141
-h, --help help
4242
```
4343

44-
Basically gitbot run an arbitrary file (-f) (could be bash, python, ruby), for each open PR.
45-
The description -d is just for readability purpose.
44+
Basically gitbot run an arbitrary file (-f) (could be bash, python, ruby), against each open PR.
45+
If you have 10 untested PRs, you have to run it 10 times.
46+
Gitbot was especially so designed, because 1 run equals a 1 Jenkins Job.
47+
4648
The **context ** -c is important: make an **unique context name** for each test category you want to run.
4749

48-
EXAMPLE: -c "python-pyflake", -c 'python-unit-tests'
50+
EXAMPLE:
51+
```-c "python-pyflake", -c 'python-unit-tests'```
4952

5053
The context trigger the exec. of tests.
5154

52-
The -f parameter, will run the test if any of this fily type is present.
53-
5455

5556
************************************************

0 commit comments

Comments
 (0)