aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: b13e4fd34adcbf68cb9ba342ab36c4ab09eff53a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
git-test
========

git-test is a script for running tests on commits in a Git repository.
It is useful for those who care every commit in a topic branch passes the
test.

git-test uses git-worktree(1) and runs the test inside a linked working tree
so that the current working tree doesn't become polluted; you can make any
changes to the local tree while running git-test in background.

For a typical topic branch workflow it is simply:

    # First define the test commands for the project
    git config --add git-test.test 'rake compile'
    git config --add git-test.test 'rake test'

    # By default every commit in master..HEAD is tested
    git test

Usage
-----

TODO: This needs to be documented.

License
-------

git-test is licensed under the MIT license. See COPYING.