Skip to content

Conventional Commits Checker

Actions
Check that all pull request commits are following conventional commits
v1.0.1
Latest
Star (1)

conventional-commits-checker

Check that all pull request commits are following conventional commits

The default commit validation pattern is: feat: #0000 - My Message commit

How to use

name: "Commit Lint"
on:
  pull_request:
    branches:
      - main
      - development
      - staging
    types:
      - opened
      - reopened
      - labeled
      - unlabeled
      - edited
      - synchronize
jobs:
  commit-lint:
    runs-on: ubuntu-latest
    name: Validate all commits
    steps:
      - uses: actions/checkout@v3
        with:
          token: ${{ secrets.PAT }} # your personal access token
          fetch-depth: 0
      - name: Conventional Commits Checker
        uses: netodevel/convetional-commits-checker@v1.0.1
        id: commits-check
        with: # do not change the order of params
          target-branch: ${{ github.event.pull_request.base.ref }}  #required
          current-branch: ${{ github.event.pull_request.head.ref }} #required
          pattern: '(feat|fix|ci|chore|docs|test|style|refactor): .{1,}$' #optional custom validation commit

Inputs

target-branch

Required Need to get all commits, use always: ${{ github.event.pull_request.base.ref }}

current-branch

Required Need to get all commits, use always: ${{ github.event.pull_request.head.ref }}

pattern

Optional Custom validation commit, eg: (feat|fix|ci|chore|docs|test|style|refactor): .{1,}$

Conventional Commits Checker is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Check that all pull request commits are following conventional commits
v1.0.1
Latest

Conventional Commits Checker is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.