From bb1db295ddb8ea0d6eea964ed583fdae091ba749 Mon Sep 17 00:00:00 2001
From: Ankit152 <ankitkurmi152@gmail.com>
Date: Tue, 17 Sep 2024 21:52:47 +0530
Subject: [PATCH] feat: added custom action for PR title checker

Signed-off-by: Ankit152 <ankitkurmi152@gmail.com>
---
 .github/actions/pr-title-checker.sh           | 47 +++++++++++++++++++
 .../actions/verifier/pr-titile-checker.yml    |  9 ++++
 README.md                                     |  4 ++
 3 files changed, 60 insertions(+)
 create mode 100644 .github/actions/pr-title-checker.sh
 create mode 100644 .github/actions/verifier/pr-titile-checker.yml

diff --git a/.github/actions/pr-title-checker.sh b/.github/actions/pr-title-checker.sh
new file mode 100644
index 0000000..88550f7
--- /dev/null
+++ b/.github/actions/pr-title-checker.sh
@@ -0,0 +1,47 @@
+#!/bin/bash
+
+# Copyright 2024 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Define regex patterns
+WIP_REGEX="^\W?WIP\W"
+TAG_REGEX="^\[[[:alnum:]\._-]*\]"
+PR_TITLE="$1"
+
+# Trim WIP and tags from title
+trimmed_title=$(echo "$PR_TITLE" | sed -E "s/$WIP_REGEX//" | sed -E "s/$TAG_REGEX//" | xargs)
+
+# Normalize common emojis in text form to actual emojis
+trimmed_title=$(echo "$trimmed_title" | sed -E "s/:warning:/⚠/g")
+trimmed_title=$(echo "$trimmed_title" | sed -E "s/:sparkles:/✨/g")
+trimmed_title=$(echo "$trimmed_title" | sed -E "s/:bug:/🐛/g")
+trimmed_title=$(echo "$trimmed_title" | sed -E "s/:book:/📖/g")
+trimmed_title=$(echo "$trimmed_title" | sed -E "s/:rocket:/🚀/g")
+trimmed_title=$(echo "$trimmed_title" | sed -E "s/:seedling:/🌱/g")
+
+# Check PR type prefix
+if [[ "$trimmed_title" =~ ^⚠ ]] || [[ "$trimmed_title" =~ ^✨ ]] || [[ "$trimmed_title" =~ ^🐛 ]] || [[ "$trimmed_title" =~ ^📖 ]] || [[ "$trimmed_title" =~ ^🚀 ]] || [[ "$trimmed_title" =~ ^🌱 ]]; then
+    echo "PR title is valid: $trimmed_title"
+    exit 0
+else
+    echo "Error: No matching PR type indicator found in title."
+    echo "You need to have one of these as the prefix of your PR title:"
+    echo "- Breaking change: ⚠ (:warning:)"
+    echo "- Non-breaking feature: ✨ (:sparkles:)"
+    echo "- Patch fix: 🐛 (:bug:)"
+    echo "- Docs: 📖 (:book:)"
+    echo "- Release: 🚀 (:rocket:)"
+    echo "- Infra/Tests/Other: 🌱 (:seedling:)"
+    exit 1
+fi
diff --git a/.github/actions/verifier/pr-titile-checker.yml b/.github/actions/verifier/pr-titile-checker.yml
new file mode 100644
index 0000000..9d5c7b0
--- /dev/null
+++ b/.github/actions/verifier/pr-titile-checker.yml
@@ -0,0 +1,9 @@
+name: "PR Title Validator"
+description: "Validates PR titles based on predefined conventions."
+inputs:
+  github-token:
+    description: "GitHub Token"
+    required: true
+runs:
+  using: "bash"
+  main: "../pr-title-checker.sh"
diff --git a/README.md b/README.md
index 2d4faab..125e391 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,10 @@ jobs:
       uses: kubernetes-sigs/kubebuilder-release-tools@v0.2
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
+    - name: Run PR Title Validator from kubebuilder-release-tools
+      uses: kubernetes-sigs/kubebuilder-release-tools/.github/actions/pr-title-checker@main
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 The code that actually runs lives in [verify](/verify), while