commit.yml

name: 'Commit Message Check'
on:
  push:
    branches: [ master ]

  pull_request:
    branches: [ master ]
    types: [assigned, opened, synchronize, reopened, edited, ready_for_review]

jobs:
  check-commit-message:
    if: ${{ github.event.pull_request.user.login != 'dependabot[bot]'  && github.event.pull_request.draft == false }}
    name: Check Commit Message
    runs-on: ubuntu-20.04
    steps:
      - name: Check Commit Type
        uses: gsactions/commit-message-checker@v2
        with:
          pattern: '^[\(\)\-a-z0-9,\s]+!?: .+(?:\n(?:\n.+)+)?(?:\n\n.+)?$'
          error: 'Your message must have the correct format "<scope>: <subject>" with an optional body and footer separated by blank lines.'
          excludeDescription: 'true'
          excludeTitle: 'true'
          checkAllCommitMessages: 'true'
          accessToken: ${{ secrets.GITHUB_TOKEN }}

      - name: Check Title Capitalize
        uses: gsactions/commit-message-checker@v2
        with:
          pattern: '^[^A-Z]'
          flags: ''
          error: 'Your title should not capitalize first word.'
          excludeDescription: 'true'
          excludeTitle: 'true'
          checkAllCommitMessages: 'true'
          accessToken: ${{ secrets.GITHUB_TOKEN }}

      - name: Check Title Length
        uses: gsactions/commit-message-checker@v2
        with:
          pattern: '^[^\s]+([ \t]+[^\s]+){2,}[ \t]*(\n.*)?$'
          flags: 's'
          error: 'A meaningful title should contain at least 3 words.'
          excludeDescription: 'true'
          excludeTitle: 'true'
          checkAllCommitMessages: 'true'
          accessToken: ${{ secrets.GITHUB_TOKEN }}

      - name: Check Title Line Length
        uses: gsactions/commit-message-checker@v2
        with:
          pattern: '^([^\n]{1,80}|Merge pull request.*)(\n.*)?$'
          flags: 's'
          error: 'The maximum title line length of 80 characters is exceeded.'
          excludeDescription: 'true'
          excludeTitle: 'true'
          checkAllCommitMessages: 'true'
          accessToken: ${{ secrets.GITHUB_TOKEN }}

      - name: Check Title Line Separator
        uses: gsactions/commit-message-checker@v2
        with:
          pattern: '^[^\n]+(\n\n.+)?$'
          flags: 's'
          error: 'Should leave an empty line after title.'
          excludeDescription: 'true'
          excludeTitle: 'true'
          checkAllCommitMessages: 'true'
          accessToken: ${{ secrets.GITHUB_TOKEN }}

      - name: Check Line Length
        uses: gsactions/commit-message-checker@v2
        with:
          pattern: '^[^\n]+(\n[^\n]{0,80})*$'
          flags: 's'
          error: 'The maximum line length of 80 characters is exceeded.'
          excludeDescription: 'true'
          excludeTitle: 'true'
          checkAllCommitMessages: 'true'
          accessToken: ${{ secrets.GITHUB_TOKEN }}