Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Pull Request Checks
name: PR Code Checks

on:
pull_request:
Expand Down
21 changes: 21 additions & 0 deletions .github/workflows/pull-request-format.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: PR Format Checks
on:
pull_request:
types:
- opened
- edited
- synchronize
- reopened

jobs:
conventional-commit:
name: Conventional Commit Title
runs-on: ubuntu-latest
# permissions:
# pull-requests: read
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Validate PR title
run: ./scripts/conventional-commit.sh "${{ github.event.pull_request.title }}"
29 changes: 29 additions & 0 deletions scripts/conventional-commit.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/usr/bin/env bash

set -euo pipefail

TITLE="${1:-}"
if [[ -z "$TITLE" ]]; then
echo "::error::PR title is required"
exit 1
fi

TYPES_REGEX="build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test"

# Conventional Commits: <type>(<scope>)?(!)?: <subject>
RE="^(${TYPES_REGEX})(\([A-Za-z0-9._/-]+\))?(!)?: .+"

if [[ ! "$TITLE" =~ $RE ]]; then
echo "::error::PR title must follow Conventional Commits.
Received: \"$TITLE\"
Expected: <type>(<scope>)?: <summary>
Allowed types: ${TYPES_REGEX//|/, }
Examples:
- feat(api): add token exchange
- fix(auth)!: reject blank client_id
- chore: bump dependencies
"
exit 1
fi

echo "PR title OK: $TITLE"