diff options
| author | Neil Williams <codehelp@debian.org> | 2015-11-06 15:52:06 +0000 |
|---|---|---|
| committer | Neil Williams <codehelp@debian.org> | 2015-11-06 15:56:04 +0000 |
| commit | 87a9b1d1b66e17850ae64cbcf5f3282abbdfb4a7 (patch) | |
| tree | eb6d6698c71669ddfc4101e93c5534723c64b97a | |
| parent | c7441bce40bd030435cb5c591ee5019e197880b4 (diff) | |
| download | vmdebootstrap-87a9b1d1b66e17850ae64cbcf5f3282abbdfb4a7.tar.gz | |
Add pre-commit hook and document usage
| -rw-r--r-- | README | 9 | ||||
| -rw-r--r-- | doc/overview.rst | 10 | ||||
| -rwxr-xr-x | pre-commit.sh | 10 |
3 files changed, 29 insertions, 0 deletions
@@ -60,6 +60,15 @@ In order to use vmdebootstrap, you'll need a few things: * python-cliapp (see http://liw.fi/cliapp/) * python-distro-info +Testing vmdebootstrap from git +------------------------------ + +There is a strongly recommended git pre-commit hook available +for vmdebootstrap development - it requires the ``cmdtest`` +package:: + + ln -s ../../pre-commit.sh .git/hooks/pre-commit + Running vmdebootstrap from git ------------------------------ diff --git a/doc/overview.rst b/doc/overview.rst index 2c3644c..c493477 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -165,6 +165,16 @@ Logging --log-keep=N keep last N logs (10) --log-mode=MODE set permissions of new log files to MODE (octal; default 0600) +Developing +********** + +Testing vmdebootstrap from git +------------------------------ + +:: + + ln -s ../../pre-commit.sh .git/hooks/pre-commit + Peformance ********** diff --git a/pre-commit.sh b/pre-commit.sh new file mode 100755 index 0000000..0fffe95 --- /dev/null +++ b/pre-commit.sh @@ -0,0 +1,10 @@ +#!/bin/sh + +set -e + +if [ -x /usr/bin/yarn ]; then + yarns/run-tests --env TESTS=fast +else + echo "Please install cmdtest to use the pre-commit hook!" + exit 1 +fi |