commit-msg-check-action

This GitHub Action enforces consistent commit message formatting for Qualcomm projects. It currently supports the following validations:

• Commit Subject : Verifies that a subject line is present and does not exceed the specified character limit.
• Commit Body : Ensures a body is provided and that each line adheres to the defined word wrap limit.
• Check Blank Line Flag: When true, ensures a blank line between the commit subject, body, and Signed-off-by signature for better readability.

Usage

Create a new GitHub Actions workflow in your project, e.g. at .github/workflows/commit-check.yml

name: Commit Msg Check Action

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  check-commits:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: read
    steps:
      - name: Check out repository
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0

      - name: Commit Check
        uses: qualcomm/commit-msg-check-action@v2
        with:
          base: ${{ github.event.pull_request.base.sha }}
          head: ${{ github.event.pull_request.head.sha }}
          body-char-limit: 72
          sub-char-limit: 50
          check-blank-line: true

Getting in Contact

If you have questions, suggestions, or issues related to this project, there are several ways to reach out:

• Report an Issue on GitHub
• Open a Discussion on GitHub
• E-mail us for general questions

License

commit-msg-check-action is licensed under the BSD-3-Clause-Clear License. See LICENSE.txt for the full license text.