Skip to content

agenthunt/conventional-commit-checker-action

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

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Conventional Commit Checker GitHub Action

This action is a conventional commit validator

  • validates PR title with conventional commit title
  • validates PR description (first comment ) with conventional commit body and footer
  • The regex can be overridden with github action inputs

Inputs

pr-title-regex

Optional Regex to match PR title. Default "^(.+)(?:(([^)s]+)))?: (.+)".

pr-body-regex

Optional Regex to match PR body. Default "(.*\n)+(.*)".

Example usage

name: CI

on:
  pull_request:
    branches: [master]
    types: [opened, edited, synchronize]

jobs:
  check-for-cc:
    runs-on: ubuntu-latest
    steps:
      - name: check-for-cc
        id: check-for-cc
        uses: agenthunt/[email protected]

NOTE

Unfortunately, it is not possible to customize the GitHub Squash and Merge description message. To really benefit from this action, please copy the PR body into the GitHub Squash and Merge description textarea.