pr-checks.md

---

PR Validation Workflow

This workflow automatically validates pull request titles, commit messages, and labels against conventional commit standards. .github/workflows/pr-checks.yml

Overview

Automatically validates:

• PR titles follow conventional commit format
• Commit messages follow conventional commit standards
• Presence of at least one label on the PR
• Supports all standard conventional commit types

Features

• Configurable conventional commit types
• Label requirement check (default true)
• Customizable subject pattern (default requires uppercase start)
• Supports WIP PRs
• Validates single commit messages when enabled
• Comprehensive error messages for validation failures

Usage

This workflow triggers automatically on PR events and can be configured with input parameters.

1️⃣ PR Title Validation

• Lightweight regex-based PR title validation script.
• Enforces Conventional Commit style titles with optional scope.
• Ensures PR titles follow Conventional Commits format.
• Example:

✅ Valid

  feat(api): Add login endpoint
  fix: Resolve token issue
  docs(readme): Update installation guide

❌ Invalid

  update login
  bug fix
  added new feature

🏷️ Check PR labels

PR Type	Label Validation
Internal PR	✅ checked
Fork PR	⏭ skipped

Example flow

Internal contributor

PR → validation runs:

PR title ✔
commits  ✔
labels   ✔

Fork contributor

PR → validation runs:

PR title ✔
commits  ✔
labels   ⏭ skipped

2️⃣ Commit Message Validation

• Using wagoid/commitlint-github-action
• Ensures all commits follow Conventional Commit format.
• Example:

✅ Valid commits

  feat(api): add login endpoint
  fix(auth): resolve token issue
  docs: update readme

❌ Invalid

  update code
  bug fix
  changes

Example Implementation

name: 'PR Validation'

on:
  pull_request:
    types:
      - opened
      - edited
      - synchronize
      - reopened

jobs:
  pr-validation:
    uses: clouddrove/github-shared-workflows/.github/workflows/pr-checks.yml@v2
    secrets: inherit
    with:
      types: |
        fix
        feat
        docs
        ci
        chore
        test
        refactor
        style
        perf
        build
        revert
      checkLabels: true  # Set to false to disable label checking

Optional Configuration

    with:
      requireScope: false  # Whether to require scope in commit messages
      subjectPattern: '^[A-Z].+$'  # Regex pattern for subject validation
      validateSingleCommit: false  # Validate single commit message only
      checkLabels: true  # Whether to check for PR labels