Merge pull request #150 from elliottmurray/style/git_message

ci: add check for commit messages

Author: elliottmurray

.travis.yml

@@ -13,6 +13,9 @@ rvm: "2.2"
 
 sudo: false
 
+before_install:
+  - script/commit_message.py
+
 install:
   - pip install -r requirements_dev.txt
 

CONTRIBUTING.md

@@ -25,3 +25,19 @@ We also appreciate it if you take the time to update and write tests for any cha
 you submit.
 
 [e2e]: https://github.com/pact-foundation/pact-python/tree/master/e2e
+
+## Commit messages
+Pact Python is adopting the Conventional Changelog commit message conventions. Please ensure you follow the guidelines, we don't want to be that person, but the commit messages are very important to the automation of our release process.
+
+Take a look at the git history (git log) to get the gist of it.
+
+If you'd like to get some CLI assistance there is a node npm package. Example usage is:
+
+```
+npm install commitizen -g
+npm i -g cz-conventional-changelog
+```
+
+git cz to commit and commitizen will guide you.
+
+There is a pypi package that does similar [commitizen]: https://pypi.org/project/commitizen/. This would make a great feature to add! There is a check on the travis build that your commits follow this convention. On creating a PR any commits that don't will instantly fail the build and you will have to rename them.

script/commit_message.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+import re
+import sys
+import subprocess
+
+examples = """+ 61c8ca9 fix: navbar not responsive on mobile
++ 479c48b test: prepared test cases for user authentication
++ a992020 chore: moved to semantic versioning
++ b818120 fix: button click even handler firing twice
++ c6e9a97 fix: login page css
++ dfdc715 feat(auth): added social login using twitter
+"""
+
+
+def main():
+
+    cmd = "git log --pretty=format:'%s' master..HEAD"
+    commits = subprocess.check_output(cmd, shell=True)
+    commits = commits.decode("utf-8").split('\n')
+    for commit in commits:
+
+        pattern = r'((build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert)(\([\w\-]+\))?:\s.*)|((Merge)(\([\w\-]+\))?\s.*)'  # noqa
+        m = re.match(pattern, commit)
+        if m is None:
+            print("\nError with git message '{}' style".format(commit))
+            print("\nPlease change commit message to the conventional format and try to commit again. Examples:")  # noqa
+
+            print("\n" + examples)
+            sys.exit(1)
+
+    print("Commit messages valid")
+
+
+if __name__ == "__main__":
+    main()