Skip to content

satvik-s/pr-title-check

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

PR Title Verify

GitHub release (latest by date) GitHub Workflow Status

GitHub action to check if a pull request title matches a regex pattern.

Configuration

Please refer to action definition and the following example workflow.

More information about pattern and flags can be found in the JavaScript reference.

flags is optional and defaults to gm. pattern is optional and defaults to conventional commit regex pattern.

Sample Workflow

name: 'PR Title Check'
on:
  pull_request:
    types:
      - opened
      - edited
      - synchronize
      - labeled
      - unlabeled

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: PR Title Verify
        uses: satvik-s/pr-title-check
        with:
          pattern: '(fix|feat|chore|docs|style|refactor|perf|test): (?:\w+\b\W*){3,8}$'

License

This project is released under the terms of the MIT License