Bash based Basic Commit Linter Github Workflow

README.md

Github Workflow for Linting Git Commits

To enable this check, create a workflow file within the .github/workflows directory, such as check-commits.yml.
It will trigger when a pull request is created to main branch and will fail if a commit contains any of the special keywords like:

• WIP - convention for commits that are work in progress
• [skip ci] - skips github workflow.
• Signed-off - git gui offers that option if you're lazy to write your own message.
• Merge something-branch into something - extra commit that happens when you merge changes. Solution is to rebase it.

Check is case insensitive.

I wrote about it in my article https://www.amarjanica.com/git-commits-that-dont-suck-a-beginners-guide#Lazy_Persons_Commit_Linter. I also wrote about some other stuff like git rebasing and clean commits.

check-commits.yml

name: Check Commits

on:
  pull_request:
    branches:
      - main

jobs:
  check-commits:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Validate commit messages
        run: |
          git fetch origin ${{ github.base_ref }} ${{ github.head_ref }}
          
          pattern='^.*(\bwip\b|\[skip ci\]|merge.+into|signed-off).*$'
          commit_messages=$(git log origin/${{ github.base_ref }}..origin/${{ github.head_ref }} --pretty=format:%s)

          echo "$commit_messages" | while read line; do
          if [[ "${line,,}" =~ $pattern ]]; then
            echo "Invalid commit message: '$line'"
            exit 1
          fi
          done