GitHub Action: commitlint

commitlint as a GitHub Action

Usage

simple

name: commit-lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: ahmadnassri/action-commit-lint@v2

use different built-in config

name: commit-lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: ahmadnassri/action-commit-lint@v2
        with:
          config: angular

use your own rules

name: commit-lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ahmadnassri/action-commit-lint@v2
        with:
          config: ./path/to/commitlint.config

Notes for custom rules:

must use action/checkout first_
config is relative to your repo’s root
config file format must follow commitlint configuration format

Inputs & Outputs

output	type	required	default	description
`token`	input	❌	`-`	The GitHub token used to inspect the pull-request commits
`config`	input	❌	`conventional`	name of config to use, or path to config file
`report`	output	`N/A`	`-`	a JSON object with the full `commitlint` report data

built-in configs

the following are available without any additional requirement

Author: Ahmad Nassri •
Twitter: @AhmadNassri