README.rst

Check your commits against Conventional Commits using Commisery

Using this GitHub action, scan your Pull Request title and all commits in your Pull Request against the Conventional Commits standard using Commisery

Usage

The workflow, usually declared in .github/workflows/build.yml, looks like:

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

jobs:
  commit-message:
    name: Conventional Commit Message Checker (Commisery)
    runs-on: ubuntu-latest
    steps:
    - name: Check-out the repo under $GITHUB_WORKSPACE
      uses: actions/checkout@v2

    - name: Run Commisery
      uses: KevinDeJong-TomTom/commisery-action@master
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        pull_request: ${{ github.event.number }}

Inputs

• token: GitHub Token provided by GitHub, see Authenticating with the GITHUB_TOKEN
• pull_request: Pull Request number, provided by the GitHub context.

Example of Conventional Commit check results

Forked for usage in dracut