Conventional Commits Laravel Package

Getting Started

1. Install via Composer: composer require ramsey/conventional-commits
2. Import the core classes: ConventionalCommit and CommitParser
3. Parse a commit message:

   $parser = new CommitParser();
   $commit = $parser->parse('feat(auth): add JWT token support');
   echo $commit->getType(); // 'feat'
   echo $commit->getDescription(); // 'add JWT token support'
   

4. Validate using CommitValidator to ensure adherence to spec before merging

Implementation Patterns

• CI/CD Validation: Run commits through CommitValidator in pre-commit hooks or GitHub Actions workflows to block non-compliant messages
• Changelog Generation: Extract metadata (type, scope, breaking changes) to auto-generate changelogs using tools like standard-version or custom scripts
• Commit Linting: Integrate with Git hooks (e.g., husky + PHP lint script) to enforce team standards
• Custom Tooling: Use parsed footers (e.g., Closes #123, Fixes #456) to auto-link issues or trigger downstream jobs
• Release Automation: Detect BREAKING CHANGE footers to bump major version automatically via semver logic

Gotchas and Tips

• Footers are key: Breaking changes must be in a BREAKING CHANGE footer (not just in the description), or they won’t be detected
• Line endings matter: The parser expects \n-separated lines; ensure CI environments normalize commit messages
• Validation is strict by default: Use CommitParser::withStrict(false) if handling legacy or relaxed formats
• Extensibility: Extend CommitParser or implement custom footer parsers for project-specific semantics (e.g., Team: backend)
• Debug tip: Call toArray() or __toString() on a parsed commit for inspection during troubleshooting
• Performance: Reuse CommitParser instances—avoid recreating them per commit in loops or CI runs