summaryrefslogtreecommitdiff
path: root/.overcommit.yml.example
diff options
context:
space:
mode:
authorGiorgenes Gelatti <ggelatti@gitlab.com>2019-09-02 05:38:27 +0000
committerThong Kuah <tkuah@gitlab.com>2019-09-02 05:38:27 +0000
commit2fb6c9f3c74b174f926aaaeae33ee14b4cba8195 (patch)
tree3cb903c35d5f1f3fb3395cb0f31b43ff3ba3952b /.overcommit.yml.example
parentcd8d008cb95ce2321b7cdb36433ff40375043ce9 (diff)
downloadgitlab-ce-2fb6c9f3c74b174f926aaaeae33ee14b4cba8195.tar.gz
Adds basic overcommit support
Diffstat (limited to '.overcommit.yml.example')
-rw-r--r--.overcommit.yml.example28
1 files changed, 28 insertions, 0 deletions
diff --git a/.overcommit.yml.example b/.overcommit.yml.example
new file mode 100644
index 00000000000..25823b9a8b3
--- /dev/null
+++ b/.overcommit.yml.example
@@ -0,0 +1,28 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+ RuboCop:
+ enabled: true
+# on_warn: fail # Treat all warnings as failures
+#
+#PostCheckout:
+# ALL: # Special hook name that customizes all hooks of this type
+# quiet: true # Change all post-checkout hooks to only display output on failure
+#
+# IndexTags:
+# enabled: true # Generate a tags file with `ctags` each time HEAD changes