🤖 ci: add conventional commit checker

.github/workflows/cz.yml

@@ -0,0 +1,38 @@
+name: Check Conventional Commit
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  check-commit-message:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Check Conventional Commit
+      run: |
+        # Define the conventional commit types with emojis
+        TYPES=("🚀 feat" "🐛 fix" "📝 docs" "✨ style" "🛠 refactor" "⚡️ perf" "🔬 test" "🔧 build" "🤖 ci" "🧹 chore" "⏪ revert")
+
+        # Extract the commit type and emoji from the commit message
+        COMMIT_MSG=$(git log --format=%B -n 1)
+        for type in "${TYPES[@]}"; do
+          type_emoji=${type}
+          type=${type_emoji#* }
+          emoji=${type_emoji% *}
+          if [[ $COMMIT_MSG == $emoji* ]]; then
+            echo "Commit message is a conventional commit"
+            exit 0
+          fi
+        done
+
+        # If we reach here, the commit message is not a conventional commit
+        echo "Commit message is not a conventional commit"
+        exit 1

push.sh

@@ -6,77 +6,72 @@
 # Define the conventional commit types with new emojis
 TYPES=("🚀 feat" "🐛 fix" "📝 docs" "✨ style" "🛠 refactor" "⚡️ perf" "🔬 test" "🔧 build" "🤖 ci" "🧹 chore" "⏪ revert")
 
-# Function to display an error and exit
+# Function to display an error and exit and
 error_exit() {
-    echo -e "\033[1;31m[ERROR]\033[0m $1"  # Prints the error message in red color
+    echo -e "\033[1;31m[ERROR]\033[0m $1"
-    exit 1  # Exits the script with a non-zero status
+    exit 1
 }
 
 # Ensure the script is run in a Git repository
 git rev-parse --is-inside-work-tree > /dev/null 2>&1 || error_exit "This is not a Git repository."
 
-# Get the current branch name using Git
+# Get the current branch name
 branch=$(git rev-parse --abbrev-ref HEAD)
 
-# Pull the latest changes from the remote repository to stay up-to-date
+# Pull the latest changes from the remote repository
 echo "Pulling latest changes from remote branch '$branch'..."
 git pull origin "$branch" || error_exit "Failed to pull changes from the remote repository. Please resolve any conflicts manually."
 
-# Check if there are any changes to commit (both staged and unstaged)
+# Prompt the user to select a commit type
-if git diff --quiet && git diff --cached --quiet; then
-    error_exit "No changes detected to commit."  # If no changes, exit the script
-fi
-
-# Prompt the user to select a commit type from the predefined list of types
 echo "Select a commit type:"
 select type in "${TYPES[@]}"; do
-    if [[ -n "$type" ]]; then  # If a valid selection is made, break the loop
+    if [[ -n "$type" ]]; then
         break
     else
-        echo "Invalid selection. Please try again."  # If invalid, prompt again
+        echo "Invalid selection. Please try again."
     fi
 done
 
-# Extract the commit type (e.g., "feat") and emoji (e.g., "🚀") from the selected type
+# Extract the commit type and emoji from the selection
-type_emoji=${type}  # The full emoji and type (e.g., "🚀 feat")
+type_emoji=${type}
-type=${type_emoji#* }  # Extract the commit type (e.g., "feat") by removing the emoji
+type=${type_emoji#* }
-emoji=${type_emoji% *}  # Extract the emoji (e.g., "🚀") by removing the type
+emoji=${type_emoji% *}
 
-# Prompt the user to enter a short description for the commit
+# Prompt the user to enter a short description
 read -p "Enter a short description: " desc
-if [ -z "$desc" ]; then  # If the description is empty, exit with an error
+if [ -z "$desc" ]; then
     error_exit "A short description is required!"
 fi
 
 # Prompt the user to enter a longer description (optional)
 read -p "Enter a longer description (optional): " long_desc
 
-# Create the commit message using the emoji, type, and description
+# Create the commit message
 commit_msg="$emoji $type: $desc"
 
-# If the user provided a longer description, append it to the commit message
+# If a longer description was provided, add it to the commit message
 if [ -n "$long_desc" ]; then
-    commit_msg+="\n\n$long_desc"  # Adds the longer description to the commit message
+    commit_msg+="\n\n$long_desc"
 fi
 
-# Print the commit message to the console for review
+# Print the commit message to the console
 echo -e "\nCommit message:"
-echo -e "\033[1;36m$commit_msg\033[0m"  # Prints the commit message in cyan color
+echo -e "\033[1;36m$commit_msg\033[0m"
 
-# Stage all changes for commit
+# Stage all changes
 git add .
 
-# Commit the changes with the constructed commit message
+# Commit the changes with the conventional commit message
 if git commit -m "$commit_msg"; then
-    echo -e "\033[1;32mCommit successful!\033[0m"  # If commit is successful, print success message in green
+    echo -e "\033[1;32mCommit successful!\033[0m"
 else
-    error_exit "Commit failed. Please check your changes and try again."  # If commit fails, show error and exit
+    error_exit "Commit failed."
 fi
 
 # Push the changes to the remote repository
 echo "Pushing changes to remote branch '$branch'..."
 if git push origin "$branch"; then
-    echo -e "\033[1;32mChanges pushed to remote branch '$branch'.\033[0m"  # If push is successful, print success message in green
+    echo -e "\033[1;32mChanges pushed to remote branch '$branch'.\033[0m"
 else
-    error_exit "Push failed. Please check your connection or branch permissions."  # If push fails, show error and exit
+    error_exit "Push failed. Please check your connection or branch permissions."
 fi