diff --git a/.githooks/pre-commit b/.githooks/pre-commit new file mode 100755 index 0000000..9d85cab --- /dev/null +++ b/.githooks/pre-commit @@ -0,0 +1,49 @@ +#!/bin/bash +# +# Pre-commit script which checks the playbook for syntax errors + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# Cross platform projects tend to avoid non-ASCII filenames; prevent +# them from being added to the repository. We exploit the fact that the +# printable range starts at the space character and ends with tilde. +if [ "$allownonascii" != "true" ] && + # Note that the use of brackets around a tr range is ok here, (it's + # even required, for portability to Solaris 10's /usr/bin/tr), since + # the square bracket bytes happen to fall in the designated range. + test $(git diff --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +Error: Attempt to add a non-ASCII file name. + +This can cause problems if you want to work with people on other platforms. + +To be portable it is advisable to rename the file. + +If you know what you are doing you can disable this check using: + + git config hooks.allownonascii true +EOF + exit 1 +fi + +set -e + +# If there are whitespace errors, print the offending file names and fail. +#git diff-index --check --cached $against -- + +# Run yamllint on yaml files +yamllint . diff --git a/README.md b/README.md index 585ce37..c7487d9 100644 --- a/README.md +++ b/README.md @@ -19,4 +19,12 @@ MIT phoenix -Have a lot of fun! \ No newline at end of file +Have a lot of fun! + +# Development + +## Add githooks + +This repository ships pre-commit git hooks that will check the yaml syntax. To configure them do + + git config --local core.hooksPath .githooks/ \ No newline at end of file