chore2: add GA for branch naming convention

chore2: add GA for sematical commit messages

Author: smarcet

.github/workflows/check-branch-name.yml

@@ -0,0 +1,19 @@
+name: Validate Branch Name
+
+on:
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+
+jobs:
+  check-branch-name:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check branch name format
+        run: |
+          BRANCH_NAME="${{ github.head_ref }}"
+          echo "Checking branch name: $BRANCH_NAME"
+          if [[ ! "$BRANCH_NAME" =~ ^(chore|feature|fix|hotfix|patch|refactor)/[a-z0-9._-]+$ ]]; then
+            echo "❌ Invalid branch name: $BRANCH_NAME"
+            echo "✅ Should match: feature/foo-bar, hotfix/issue-123, etc."
+            exit 1
+          fi

.github/workflows/check-commit-message.yml

@@ -0,0 +1,10 @@
+name: Check Commit Messages
+
+on: [pull_request]
+
+jobs:
+  lint-commits:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: wagoid/commitlint-github-action@v5

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx commitlint --edit "$1"

commitlint.config.js

@@ -0,0 +1,76 @@
+const WIP_REGEX = /^wip[:]?$/i;
+const RULE_ERROR_LEVEL = 2;
+const HEADER_MAX_LENGTH = 100;
+const SUBJECT_MIN_LENGTH = 5;
+
+module.exports = {
+    extends: ["@commitlint/config-conventional"],
+    rules: {
+        "custom-subject-empty": [RULE_ERROR_LEVEL, "never"],
+        "custom-type-enum": [RULE_ERROR_LEVEL, "always"],
+        "custom-no-wip": [RULE_ERROR_LEVEL, "always"],
+        "custom-no-wip-subject": [RULE_ERROR_LEVEL, "always"],
+        "subject-min-length": [RULE_ERROR_LEVEL, "always", SUBJECT_MIN_LENGTH],
+        "subject-case": [0], // optional: allow flexibility in subject case
+        "header-max-length": [RULE_ERROR_LEVEL, "always", HEADER_MAX_LENGTH]
+    },
+    plugins: [
+        {
+            rules: {
+                "custom-subject-empty": ({ subject }) =>
+                    subject && subject.trim().length > 0
+                        ? [true]
+                        : [
+                            false,
+                            "The commit needs a description after the colon (:). Eg: feat: add new feature"
+                        ],
+                "custom-type-enum": ({ type }) => {
+                    const allowedTypes = [
+                        "feat",
+                        "fix",
+                        "hotfix",
+                        "docs",
+                        "style",
+                        "refactor",
+                        "test",
+                        "chore"
+                    ];
+
+                    if (!type) {
+                        return [
+                            false,
+                            "Missing type. Use: feat, fix, chore, refactor, etc."
+                        ];
+                    }
+
+                    if (!allowedTypes.includes(type)) {
+                        return [
+                            false,
+                            `Type "${type} is invalid". Allowed types: ${allowedTypes.join(
+                                ", "
+                            )}`
+                        ];
+                    }
+
+                    return [true];
+                },
+                "custom-no-wip": ({ header }) => {
+                    const isWipOnly = WIP_REGEX.test(header.trim());
+                    return [
+                        !isWipOnly,
+                        "Commit message cannot be just \"WIP\" (use a descriptive message)."
+                    ];
+                },
+                "custom-no-wip-subject": ({ subject }) => {
+                    if (!subject) return [true];
+
+                    const isWipOnly = WIP_REGEX.test(subject.trim());
+                    return [
+                        !isWipOnly,
+                        "Subject cannot be just \"WIP\". Use a descriptive message like \"implement user login\" instead."
+                    ];
+                }
+            }
+        }
+    ]
+};

package.json

@@ -2,11 +2,14 @@
   "private": true,
   "scripts": {
     "prod": "gulp --production",
-    "dev": "gulp watch"
+    "dev": "gulp watch",
+    "prepare": "husky"
   },
   "devDependencies": {
     "gulp": "^3.9.1",
     "laravel-elixir": "^5.0.0",
-    "bootstrap-sass": "^3.3.0"
+    "bootstrap-sass": "^3.3.0",
+    "@commitlint/config-conventional": "^19.8.1",
+    "husky": "^9.0.11"
   }
 }