Skip to content

Add script/pr_body_check to validate PR body sections #1120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kitcommerce wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Add script/pr_body_check to validate PR body sections #1120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions script/pr_body_check
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#!/usr/bin/env bash
# script/pr_body_check
# Validates that a PR body includes required sections.
# Usage: ./script/pr_body_check <PR_NUMBER_OR_URL>

set -euo pipefail

if [[ $# -lt 1 ]]; then
echo "Usage: $0 <PR_NUMBER_OR_URL>" >&2
exit 1
fi

PR_ARG="$1"

# Fetch the PR body via gh CLI
if ! PR_BODY=$(gh pr view "$PR_ARG" --json body --jq '.body' 2>&1); then
echo "Error fetching PR: $PR_BODY" >&2
exit 2
fi

PASS=true

# Case-insensitive check for "Client impact" section
if echo "$PR_BODY" | grep -qi "client impact"; then
echo "✅ \"Client impact\" section found."
else
echo "❌ Missing required section: \"Client impact\"."
PASS=false
fi

# Case-insensitive check for "Verification Plan" section
if echo "$PR_BODY" | grep -qi "verification plan"; then
echo "✅ \"Verification Plan\" section found."
else
echo "❌ Missing required section: \"Verification Plan\"."
PASS=false
fi

if [[ "$PASS" == "false" ]]; then
echo ""
echo "PR body validation FAILED. Please add the missing section(s) above." >&2
exit 1
fi

echo ""
echo "PR body validation PASSED."
Loading