Skip to content

GitHub action for running Conventional Commit message checker (Commisery) on push

License

Notifications You must be signed in to change notification settings

dracutdevs/commisery-action

 
 

Repository files navigation

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

Example of Conventional Commit check results

resources/example.png

Forked for usage in dracut

About

GitHub action for running Conventional Commit message checker (Commisery) on push

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 53.9%
  • Dockerfile 26.3%
  • Shell 19.8%