https://github.com/qualcomm/commit-msg-check-action

A GitHub Action for Qualcomm projects that validates commit message formatting
https://github.com/qualcomm/commit-msg-check-action

Last synced: 5 months ago
JSON representation

A GitHub Action for Qualcomm projects that validates commit message formatting

• Host: GitHub
• URL: https://github.com/qualcomm/commit-msg-check-action
• Owner: qualcomm
• License: bsd-3-clause-clear
• Created: 2025-09-08T06:00:47.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-11-25T10:16:41.000Z (7 months ago)
• Last Synced: 2025-11-28T16:30:18.980Z (7 months ago)
• Language: Python
• Size: 18.6 KB
• Stars: 0
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE-OF-CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# 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

    

        steps:    

          - name: Run custom commit check

            uses: qualcomm/commit-msg-check-action@v1.0.0

            env: 

              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

            with:

              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](../../issues)

* [Open a Discussion on GitHub](../../discussions)

* [E-mail us](mailto:ynancher@qti.qualcomm.com,lint.core@qti.qualcomm.com) for general questions

## License

commit-msg-check-action is licensed under the [BSD-3-Clause-Clear License](https://spdx.org/licenses/BSD-3-Clause-Clear.html). See [LICENSE.txt](LICENSE.txt) for the full license text.