Skip to content

PRISM v2 - Pull Request Integrity & Standards Monitor

Pre-release
Pre-release

Choose a tag to compare

@mukhteshpendem mukhteshpendem released this 25 Feb 21:33
2619ef0

Prism: PR Title Validator Action

Prism is a lightweight and efficient GitHub Action designed to enforce consistent and standardized pull request (PR) titles across your repositories. By validating PR titles against the Conventional Commits specification, Prism helps maintain a clean and readable Git history — ensuring every change is properly categorized and easy to track.

🌟 Key Features

  • 📝 Enforces Conventional Commit Standards — Supports prefixes like feat:, fix:, docs:, refactor:, and more.
  • ⚡ Simple and Fast Integration — Works out-of-the-box with any GitHub repository.
  • 🚀 Lightweight Docker-Based Action — Minimal dependencies for quick execution.
  • 🛠️ Flexible and Configurable — Easily extend and adapt validation rules.

🗂️ Supported Commit Types

  • feat: New feature implementation
  • fix: Bug fixes and patches
  • docs: Documentation updates
  • chore: Routine tasks and maintenance
  • refactor: Code restructuring without behavior changes
  • test: Adding or updating tests
  • style: Code style changes (formatting, whitespace)
  • perf: Performance optimizations
  • ci: CI/CD configuration changes
  • build: Build system and dependency updates
  • revert: Reverts a previous commit

🛠️ Usage Example

Add the following to your GitHub Actions workflow:

name: PR Title Validation

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

jobs:
  validate-pr:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Validate PR title
        uses: MukhteshPendem/prism@v1.0.0
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}