Adding check-branch-name hook

Author: jmcazaux

.pre-commit-hooks.yaml

@@ -10,3 +10,9 @@
   entry: pre_commit_hooks/check-comments.sh
   language: script
   types: [python]
+- id: check-branch-name
+  name: Check the compliance of your branch name
+  description: Checks that the name of the branch you are committing to is compliant with a given regex
+  entry: pre_commit_hooks/check-branch-name.sh
+  language: script
+  pass_filenames: false

pre_commit_hooks/check-branch-name.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+while getopts r: flag
+do
+    case "${flag}" in
+        r) BRANCH_NAME_REGEX=${OPTARG};;
+        *) echo "Invalid flag provided ($flag)"; exit 1;
+    esac
+done
+
+if [[ $BRANCH_NAME_REGEX == "" ]]; then
+  echo "No regular expression provided to validate the branch name..."
+  echo "Please provide one using the '-r' argument."
+  echo ""
+  echo "Sample 'repo' section of your '.pre-commit-config.yaml' file:"
+  echo "- repo: https://github.com/alma/pre-commit-hooks"
+  echo "  rev: v1.1.0"
+  echo "  hooks:"
+  echo "  - id: check-branch-name"
+  echo "    args:"
+  echo '      - "-r^(((ci|docs|feature|fix|hotfix|perf|refactor|test)\/.*)|main)$"'
+  exit 1
+fi
+
+BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)
+
+if ! [[ $BRANCH_NAME =~ $BRANCH_NAME_REGEX ]]; then
+    echo "*** Commit interrupted ***"
+    echo "Your branch name does not match the naming convention."
+    echo "Branch names should match \"$BRANCH_NAME_REGEX\"..."
+
+    exit 1
+fi