Commit-Check GitHub Action

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

Usage

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
    steps:
      - uses: actions/checkout@v4
      - uses: commit-check/commit-check-action@v1
        with:
          message: true
          branch: true
          author-name: true
          author-email: true
          commit-signoff: true
          dry-run: true
          job-summary: true

Optional Inputs

message

• Description: check commit message formatting convention.
  • By default the rule follows conventional commits.
• Default: 'true'

branch

• Description: check git branch naming convention.
  • By default follow bitbucket branching model.
• Default: 'true'

author-name

• Description: check committer author name
• Default: 'true'

author-email

• Description: check committer author email
• Default: 'true'

commit-signoff

• Description: check committer commit signature
• Default: 'true'

dry-run

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

job-summary

• Description: display job summary to a workflow run
• Default: 'true'

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

GitHub Action job summary

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

Success job summary

Failure job summary

Badging your repository

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

Versioning follows Semantic Versioning.

Have question or feedback?

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