commitlint

📓 Lint commit messages with GitHub Actions.

Quick Start

# .github/workflows/commitlint.yml
name: commitlint
on: push
jobs:
  commitlint:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Commitlint
        uses: remarkablemark/commitlint@v1
        with:
          checkout: true

Usage

Validate last commit message or all commit messages in a pull request:

- uses: remarkablemark/commitlint@v1
  with:
    checkout: true

See action.yml

Inputs

checkout

Optional: Whether to checkout the repository:

- uses: remarkablemark/commitlint@v1
  with:
    checkout: true

Omit this input if the repository has already been checked out with all of the history:

- uses: actions/checkout@v4
  with:
    fetch-depth: 0
- uses: remarkablemark/commitlint@v1

config

Optional: The config to enforce conventional commits. Defaults to @commitlint/config-conventional:

- uses: remarkablemark/commitlint@v1
  with:
    config: '@commitlint/config-angular'

from

Optional: The lower end of the commit range to lint. Defaults to HEAD~1:

- uses: remarkablemark/commitlint@v1
  with:
    from: HEAD~

version

Optional: The version of @commitlint/cli. Defaults to latest:

- uses: remarkablemark/commitlint@v1
  with:
    version: 19.8.0

License

MIT