actions/pull-request-lint
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 5 Packages Wiki Activity Actions
pull-request-lint/README.md
Jan Klattenhoff 7e2de542b6
docs: update README with usage and validation rules (#7) 
Reviewed-on: #7
Co-authored-by: Jan Klattenhoff <jan@kjan.email>
Co-committed-by: Jan Klattenhoff <jan@kjan.email>
2025-04-09 16:43:32 +00:00

1.1 KiB
Raw Permalink Blame History

pull-request-lint

A GitHub/Gitea Action that lints pull request titles to ensure they follow the Conventional Commits format.

Usage

Add the following to your GitHub/Gitea workflow:

name: Pull Request Lint

on:
  pull_request:
    types: [opened, edited, reopened, synchronize]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install go
        uses: actions/setup-go@v5
        with:
          go-version: 1.24.2
      - uses: https://git.kjan.de/actions/pull-request-lint@release

Validation Rules

The action enforces the following Conventional Commits rules for PR titles:

  • Format must be: type(scope)!: description (scope and breaking change marker ! are optional)
  • Type and scope must be lowercase
  • Description must start with lowercase
  • Breaking change indicator and footer are mutually exclusive
  • Body must be separated from description by a blank line
  • Footer tokens must use hyphens instead of spaces (except for "BREAKING CHANGE")

License

See LICENSE file for details.