action-conventional-commits/README.md

Conventional Commits GitHub Action

A simple GitHub action that makes sure all commit messages are following the Conventional Commits specification.

Note that, typically, you would make this check on a pre-commit hook (for example, using something like Commitlint), but those can easily be skipped, hence this GitHub action.

Usage

Latest version: v1.1.0

name: Conventional Commits

on:
  pull_request:
    branches: [ master ]

jobs:
  build:
    name: Conventional Commits
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: webiny/action-conventional-commits@v1.1.0
        # optional, required for private repos
        # with:
        #   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}