A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more.

• Removed support for commit-signoff, merge-base, and imperative inputs — now configured via commit-check.toml or cchk.toml.
• Deprecated .commit-check.yml in favor of commit-check.toml or cchk.toml.
• Changed default values of author-name and author-email inputs to false to align with the default behavior in commit-check.
• Upgraded core dependency commit-check to v2.0.0.

• Usage
• Optional Inputs
• GitHub Action Job Summary
• GitHub Pull Request Comments
• Badging Your Repository
• Versioning

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

name: Commit Check

on:
  push:
  pull_request:
    branches: 'main'

jobs:
  commit-check:
    runs-on: ubuntu-latest
    permissions:  # use permissions because use of pr-comments
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v5
        with:
          ref: ${{ github.event.pull_request.head.ref }}  # Checkout PR branch
          fetch-depth: 0  # Required for merge-base checks
      - uses: commit-check/commit-check-action@v2
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed for PR comments
        with:
          message: true
          branch: true
          author-name: false
          author-email: false
          job-summary: true
          pr-comments: ${{ github.event_name == 'pull_request' }}

Apache   discovery-unicamp   Texas Instruments   OpenCADC   Extrawest Chainlift   Mila   RLinf   and many more.

• Description: check git commit message following Conventional Commits.
• Default: true

• Description: check git branch name following Conventional Branch.
• Default: true

• Description: check committer author name.
• Default: false

• Description: check committer author email.
• Default: false

• Description: run checks without failing. exit code is 0; otherwise is 1.
• Default: false

• Description: display job summary to the workflow run.
• Default: true

• Description: post results to the pull request comments.
• Default: false

Note: the default rule of above inputs is following this configuration. If you want to customize, just add your commit-check.toml config file under your repository root directory.

By default, commit-check-action results are shown on the job summary page of the workflow.

You can add a badge to your repository to show your contributors/users that you use commit-check!

Markdown

[![Commit Check](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml)

reStructuredText

.. image:: https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg
    :target: https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml
    :alt: Commit Check

Versioning follows Semantic Versioning.

To provide feedback (requesting a feature or reporting a bug), please post to issues.