Skip to content

Ensures that all commits are following the conventional-commits standard.

Notifications You must be signed in to change notification settings

rapyuta-robotics/action-conventional-commits

 
 

Repository files navigation

Conventional Commits GitHub Action

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

Screenshot

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.1

name: Conventional Commits

on:
  pull_request:
    branches:
    - main
    - dev

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

      - uses: rapyuta-robotics/action-conventional-commits@v1.1.1
        name: Check commit hygiene
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

About

Ensures that all commits are following the conventional-commits standard.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 87.7%
  • JavaScript 12.3%