conventional-commits-check-action/README.md

Conventional Commits Check Action

A GitHub Action / Gitea Action for enforcing adherance to Conventional Commits.

You can use the Action as follows:

name: Validate PR Title
on:
  pull_request_target:
    types:
      - opened
      - edited
      - synchronize
      - reopened
      - labeled
      - unlabeled
jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: https://git.tainton.uk/actions/conventional-commits-check-action@v1.0.0
        with:
          commit-message: ${{ github.event.pull_request.title }}

name: Validate Commit Message
on:
  push:
    branches:
      - main
jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: https://git.tainton.uk/actions/conventional-commits-check-action@v1.0.0
        with:
          commit-message: ${{ github.event.head_commit.message }}

Properties

The Conventional Commits Check Action has a property which is passed to the underlying script. These are passed to the action using with.

Property	Description
commit-message	The commit message you would like to validate.