conventional-commit-validator

This GitHub Action ensures that either all commit messages or the pull request title adhere to the Conventional Commits standard, and by extension our own set of types. It labels the PR accordingly with the types as well as scopes used.

Features

• Validation: Checks that either all commit messages or the PR title follow the Conventional Commits standard.
• Labeling: Automatically adds labels to the PR based on commit types and scopes.

Inputs

Name	Description	Required	Default
GITHUB_TOKEN	GitHub token to access API.	Yes	N/A
task_types	Comma-separated list of allowed commit types.	No	feat,fix,docs,test,ci,refactor,perf,chore,build,style,ops
add_label	Whether to add commit type labels to the PR.	No	true
add_scope_label	Whether to add scope-based labels.	No	true
custom_labels	Adds custom labels to the types used.	No	{"feat":"feature","docs":"documentation","ci":"CI/CD","perf":"performance"}
link_on_failure	Adds a link to the error message with a note saying "Read more here: ".	No	undefined

Usage

To utilize this action in your workflow, add the following job to your .github/workflows/ YAML file:

name: PR Conventional Commit Validation

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

jobs:
  validate-commits-or-pr-title:
    runs-on: ubuntu-latest
    steps:
      - uses: FritjofH/conventional-commit-validator@main
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          task_types: 'feat,fix,docs,test,ci,refactor,perf,chore,build,style,ops'
          add_label: true
          add_scope_label: true
          custom_labels: '{"feat":"feature","docs":"documentation","ci":"CI/CD","perf":"performance"}'

The above are the default values.

Building the Action

This action is built using Node.js. Before committing changes, ensure you compile the source code:

1. Install Dependencies:

   npm install

2. Build:

   npm run build

This compiles the source code into a single file located in the dist directory, ensuring all dependencies are bundled.