Skip to content

Commit

Permalink
ci: fix pr title verifier
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamacedo86 committed Aug 24, 2024
1 parent 4979e43 commit 8b4487e
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 13 deletions.
27 changes: 14 additions & 13 deletions .github/workflows/verify.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
name: PR Verifier
name: "PR Title Verifier"

on:
pull_request:
types: [opened, edited, synchronize,reopened]

permissions:
contents: read # Read-only access to repository contents
pull-requests: read # Read-only access to pull request details
types: [opened, edited, synchronize, reopened]

jobs:

verify:
name: Verify PR contents
runs-on: ubuntu-latest

steps:
- name: Verifier action
id: verifier
uses: kubernetes-sigs/kubebuilder-release-tools@v0.4.3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
- name: Checkout code
uses: actions/checkout@v4

- name: Get PR title
id: get_title
run: echo "title=${{ github.event.pull_request.title }}" >> $GITHUB_ENV

- name: Run PR Title Checker
id: check_title
run: |
./hack/ci/pr_title_checker.sh "${{ env.title }}"
39 changes: 39 additions & 0 deletions hack/ci/pr_title_checker.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#!/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)

# 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

0 comments on commit 8b4487e

Please sign in to comment.