From bfa0c03a8f50d50b30c8a4c3f573f43d437285d5 Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Thu, 2 Jan 2025 16:38:35 +0000 Subject: [PATCH] Replace Depecated Action to validate the PR Title with script The action is deprecated and goes away when Kubebuilder GCP Project no longer be available. Therefore, this PR replaces the action for the shell script that does the same check. More info: https://github.com/kubernetes-sigs/kubebuilder-release-tools?tab=readme-ov-file#pr-verification-github-action-deprecated --- .github/workflows/pr-title.yaml | 11 +++++--- hack/test/pr-title.sh | 50 +++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 4 deletions(-) create mode 100644 hack/test/pr-title.sh diff --git a/.github/workflows/pr-title.yaml b/.github/workflows/pr-title.yaml index 87d54f59b..c303af390 100644 --- a/.github/workflows/pr-title.yaml +++ b/.github/workflows/pr-title.yaml @@ -7,7 +7,10 @@ jobs: runs-on: ubuntu-latest name: Verify PR title steps: - - name: Verify PR title - uses: kubernetes-sigs/kubebuilder-release-tools@v0.4.3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} + - name: Verify PR title + id: get_title + run: echo "title=${{ github.event.pull_request.title }}" >> $GITHUB_ENV + - name: Run Check + id: check_title + run: | + ./hack/test/pr-title.sh "${{ env.title }}" diff --git a/hack/test/pr-title.sh b/hack/test/pr-title.sh new file mode 100644 index 000000000..fa2514441 --- /dev/null +++ b/hack/test/pr-title.sh @@ -0,0 +1,50 @@ +#!/bin/bash + +# Copyright 2024 The Kubernetes Authors. +# +# This file is copied from: +# https://github.com/kubernetes-sigs/kubebuilder/blob/master/test/pr-title-checker.sh +# +# 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