conventional-commits-action

README

conventional-commits-action

This action validates a Pull Request title and commit messages against Conventional Commits guidelines

A valid title or commit message must follow this structure:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Usage

- name: Conventional Commits
  uses: crqra/conventional-commits-action@1.0.0

Example

name: Test

on:
  pull_request:
    branches: [main]
    types: [opened, reopened, synchronize, edited, ready_for_review]

jobs:
  conventional-commits:
    runs-on: ubuntu-latest
    steps:
      - name: Conventional Commits
        uses: crqra/conventional-commits-action@1.0.0

Contributing

Thanks for considering contributing.

• Open an issue if you have a problem or found a bug
• Open a Pull Request if you have a suggestion, improvement or bug fix

License

This project is released under the MIT License.